APIDocuments

List or search documents

GET /documents

GET
/documents

Authorization

apiKey connector:read
headerAuthorizationBearer <token>

ChatPRD API key from Settings → API Keys, sent as Authorization: Bearer <key>. Read-only keys carry the connector:read scope; read/write keys also carry connector:write. Requires a Pro, Team or Enterprise plan.

Scope: connector:read

Query Parameters

q?string

Full-text search over document titles and content (1–200 characters).

Length1 <= length <= 200
organizationId?string

Clerk organization ID (org_…). Scopes the request to that team workspace instead of the personal workspace.

projectId?string

Project ID, as returned by GET /projects.

limit?integer

Maximum number of items to return (1–100). Defaults to 20.

Range1 <= value <= 100
Default20

Response Body

Matching documents, newest first.

application/json
  1. response
documents*array<>
count*integer
Example Request
curl -X GET 'https://app.chatprd.ai/api/connectors/v1/documents'
Example Response
{  "documents": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "threadId": "string",      "url": "http://example.com"    }  ],  "count": 0}