List documents | Pyramid AI

curl https://api-staging.pyramid-ai.com/api/v2/documents \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "request_id": "req_7f8e9d6c-1234-5678-abcd-9f0e1d2c3b4a",
  "success": true,
  "data": [
    {
      "id": "d4f1a2b3-9c8e-4f7a-8b2d-3e5f6a7c9d01",
      "org_id": "org_ais",
      "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "file_name": "Q1_Financial_Report.pdf",
      "content_type": "application/pdf",
      "size_bytes": 245760,
      "status": "processed",
      "chunk_count": 12,
      "error_message": "",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ],
  "pagination": {
    "total": 127,
    "offset": 0,
    "limit": 50
  }
}

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Query parameters

project_idstringOptionalformat: "uuid"

document_idsstringOptional

Comma-separated list of document UUIDs to filter by

statusenumOptional

Allowed values:

limitintegerOptional<=200Defaults to 50

offsetintegerOptionalDefaults to 0

Response

List of documents

request_idstringformat: "uuid"

Server-generated per-request UUID. Also sent as X-Request-Id response header. Include in support tickets.

successany

datalist of objects

paginationobject

Offset-based pagination for list endpoints. Clients compute has_more from offset + data.length < total. Cursor pagination may be added per-endpoint later if deep-pagination performance becomes a concern.

Errors

400

Bad Request Error

401

Unauthorized Error

$	curl https://api-staging.pyramid-ai.com/api/v2/documents \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"request_id": "req_7f8e9d6c-1234-5678-abcd-9f0e1d2c3b4a",
3	"success": true,
4	"data": [
5	{
6	"id": "d4f1a2b3-9c8e-4f7a-8b2d-3e5f6a7c9d01",
7	"org_id": "org_ais",
8	"project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
9	"file_name": "Q1_Financial_Report.pdf",
10	"content_type": "application/pdf",
11	"size_bytes": 245760,
12	"status": "processed",
13	"chunk_count": 12,
14	"error_message": "",
15	"created_at": "2024-01-15T09:30:00Z",
16	"updated_at": "2024-01-20T14:45:00Z"
17	}
18	],
19	"pagination": {
20	"total": 127,
21	"offset": 0,
22	"limit": 50
23	}
24	}