# Peeve

> API and MCP documentation for Peeve — the in-product agent that shows users how to do things.

## Docs

- [Introduction](https://docs.peeve.ai/get-started/introduction.md): What Peeve exposes to developers, and which surface to reach for.
- [Quickstart](https://docs.peeve.ai/get-started/quickstart.md): Install the widget and make one authenticated API call.
- [Choosing a surface](https://docs.peeve.ai/get-started/surfaces.md): Which endpoint or integration solves which problem.
- [Authentication](https://docs.peeve.ai/authentication/overview.md): Two kinds of key, and the boundary each one defends.
- [Creating and rotating keys](https://docs.peeve.ai/authentication/keys.md): Where keys come from, how they are stored, and how to roll one without downtime.
- [Origins](https://docs.peeve.ai/authentication/origins.md): The rule that makes a public key safe to publish.
- [Installing the widget](https://docs.peeve.ai/widget/install.md): The script tag, its attributes, and the npm package.
- [JavaScript API](https://docs.peeve.ai/widget/javascript-api.md): The methods the widget exposes on the page, and the ones the npm package exposes.
- [Identity and context](https://docs.peeve.ai/widget/identity-and-context.md): What belongs in identify, what belongs in setContext, and how each is stored.
- [MCP server](https://docs.peeve.ai/mcp/overview.md): A live Model Context Protocol endpoint over your product's verified capabilities — and what it deliberately will not do.
- [Workspace endpoint](https://docs.peeve.ai/mcp/workspace-endpoint.md): GET and POST /api/mcp/{workspaceId} — the unauthenticated, guide-only MCP server.
- [Per-user grants](https://docs.peeve.ai/mcp/per-user-grants.md): The revocable, per-contact MCP endpoint and its pv_grant_ bearer tokens.
- [Connect a client](https://docs.peeve.ai/mcp/connect-a-client.md): Configuring Claude, Cursor and other MCP clients against your Peeve endpoint.
- [Agent artifacts](https://docs.peeve.ai/artifacts/overview.md): Static files that let an agent discover your product without connecting to anything.
- [Artifact reference](https://docs.peeve.ai/artifacts/reference.md): The exact structure of each generated file.
- [Errors](https://docs.peeve.ai/reference/errors.md): Status codes and error bodies across the API, MCP and artifact surfaces.
- [Rate limits](https://docs.peeve.ai/reference/rate-limits.md): Where limits apply, the per-plan ceilings, and how to handle a 429.
- [Plans and gating](https://docs.peeve.ai/reference/plans.md): Which features need which plan, and what happens when a workspace is not entitled.
- [Data handling](https://docs.peeve.ai/reference/data-handling.md): What is encrypted, what is plaintext, and what is never stored.
- [API reference](https://docs.peeve.ai/api/overview.md): Base URL, authentication, and what the public API covers.
- [Push a user](https://docs.peeve.ai/api/server/users/push-a-user.md): Create or update one of your users in Peeve, keyed by `(workspace, external_user_id)`.
- [Read the kill switch](https://docs.peeve.ai/api/server/kill-switch/read-the-kill-switch.md): Return the current state of the workspace kill switch.
- [Toggle the kill switch](https://docs.peeve.ai/api/server/kill-switch/toggle-the-kill-switch.md): Turn the workspace kill switch on or off.

## OpenAPI Specs

- [server](https://docs.peeve.ai/openapi/server.json)