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 project by ID
      • DELDelete a project
      • PATCHUpdate a project
      • GETList Connect projects
      • POSTCreate a new Connect project
Get API Key
LogoLogo
API ExplorerProjects

Get a project by ID

GET
/api/v2/projects/:id
GET
/api/v2/projects/:id
$curl https://api-staging.pyramid-ai.com/api/v2/projects/id \
>     -H "Authorization: Bearer <token>"
1{
2  "request_id": "string",
3  "success": null,
4  "data": {
5    "id": "7f9c8d2a-1b3e-4c5d-8e9f-0a1b2c3d4e5f",
6    "org_id": "org_ais",
7    "name": "Q1 Surveys",
8    "description": "Batch of 2026 Q1 arboricultural assessments",
9    "document_count": 42,
10    "created_at": "2026-04-10T09:00:00Z",
11    "updated_at": "2026-04-14T12:00:00Z"
12  },
13  "pagination": {
14    "total": 127,
15    "offset": 0,
16    "limit": 50
17  }
18}
Was this page helpful?
Previous

Delete a project

Next
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Path parameters

idstringRequiredformat: "uuid"

Response

Project 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