ChatPRD API overview
Read, search, create and update your ChatPRD documents from scripts and AI agents with a personal API key.
The ChatPRD REST API lets scripts and AI agents work with your workspace on your behalf: list, search and read documents, create new documents from Markdown, rewrite existing ones, and look up projects, templates, organizations and chats.
It is available on Pro, Team and Enterprise plans.
Base URL
https://app.chatprd.ai/api/connectors/v1All requests and responses use JSON (Content-Type: application/json).
Quick start
- Create a key at Settings → API Keys. Copy it right away; it is only shown once.
- Send it as a Bearer token:
curl https://app.chatprd.ai/api/connectors/v1/me \
-H "Authorization: Bearer $CHATPRD_API_KEY"- List your most recent documents:
curl "https://app.chatprd.ai/api/connectors/v1/documents?limit=5" \
-H "Authorization: Bearer $CHATPRD_API_KEY"Endpoints
| Method | Path | Scope | Reference |
|---|---|---|---|
| GET | /me | read | Current user |
| GET | /documents | read | List or search documents |
| POST | /documents | write | Create a document |
| GET | /documents/{id} | read | Get a document |
| PATCH | /documents/{id} | write | Update a document |
| GET | /projects | read | List projects |
| GET | /templates | read | List templates |
| GET | /organizations | read | List organizations |
| GET | /chats | read | List or search chats |
The reference pages are generated from the OpenAPI document and include an interactive "Try it" panel. It sends real requests with your key, so write calls change your actual documents. For guidance, see Authentication, Working with documents, Workspace resources and Errors.
Using the API from an AI agent
Any agent that can make HTTPS requests can use this API. If you are connecting Meta Muse, follow the Muse connector guide. For Claude, Cursor, ChatGPT and other MCP clients, use the ChatPRD MCP integration instead.