For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get API Key
GuidesAPI Reference
GuidesAPI Reference
  • Overview
    • API Reference
  • Endpoint Reference
    • Organizations
    • Projects
    • Documents
    • Agent
    • Check
  • API Explorer
      • GETGet a document by ID
      • POSTTrigger processing for uploaded documents
      • GETList documents
      • POSTReserve a document upload slot
      • DELDelete documents by ID
Get API Key
LogoLogo
API ExplorerDocuments

Get a document by ID

GET
/api/v2/documents/:id
GET
/api/v2/documents/:id
$curl https://api-staging.pyramid-ai.com/api/v2/documents/id \
> -H "Authorization: Bearer <token>"
1{
2 "request_id": "string",
3 "success": null,
4 "data": {
5 "id": "9d11d31d-17ce-4b9f-8c13-63d7058f5fd3",
6 "org_id": "org_ais",
7 "project_id": "7f9c8d2a-1b3e-4c5d-8e9f-0a1b2c3d4e5f",
8 "file_name": "tree_survey_q1.pdf",
9 "content_type": "application/pdf",
10 "size_bytes": 12457833,
11 "status": "ready",
12 "chunk_count": 128,
13 "error_message": null,
14 "created_at": "2026-04-14T12:00:00Z",
15 "updated_at": "2026-04-14T12:15:00Z"
16 },
17 "pagination": {
18 "total": 127,
19 "offset": 0,
20 "limit": 50
21 }
22}
Was this page helpful?
Previous

Trigger processing for uploaded documents

Next
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Path parameters

idstringRequiredformat: "uuid"

Response

Document details
request_idstringformat: "uuid"

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

successany
dataobject
paginationobject

Present only on list endpoints. Top-level (not nested inside data).

Errors

401
Unauthorized Error
404
Not Found Error