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
      • GETList requirements for a check run
      • GETGet a check run with full results
      • POSTTrigger processing for a check run
      • GETList compliance check runs
      • POSTCreate a compliance check run
      • POSTVerify a single compliance requirement
Get API Key
LogoLogo
API ExplorerCheck

Get a check run with full results

GET
/api/v2/check/runs/:id
GET
/api/v2/check/runs/:id
$curl https://api-staging.pyramid-ai.com/api/v2/check/runs/id \
>     -H "Authorization: Bearer <token>"
1{
2  "request_id": "string",
3  "success": null,
4  "data": {
5    "created_at": "2024-01-15T09:30:00Z",
6    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
7    "name": "Q2 2026 Fire Safety Audit",
8    "org_id": "org_ais",
9    "project_id": "string",
10    "status": "pending",
11    "total_requirements": 1,
12    "updated_at": "2024-01-15T09:30:00Z",
13    "description": "Quarterly audit checking all fire safety requirements against project documentation",
14    "failed_requirements": 1,
15    "passed_requirements": 1,
16    "processed_requirements": 1,
17    "processing_completed_at": "2024-01-15T09:30:00Z",
18    "processing_started_at": "2024-01-15T09:30:00Z",
19    "project_name": "string",
20    "requirements": [
21      {
22        "id": "req_1a2b3c4d-5678-90ab-cdef-123456789012",
23        "run_id": "string",
24        "text": "Emergency exits must be clearly marked with illuminated signage on every floor",
25        "order_index": 0,
26        "status": "completed",
27        "created_at": "2024-01-15T09:30:00Z",
28        "updated_at": "2024-01-15T09:30:00Z",
29        "sub_requirements": [
30          {
31            "id": "string",
32            "requirement_id": "string",
33            "text": "string",
34            "justification": "string",
35            "score": 1.1,
36            "status": "string",
37            "created_at": "2024-01-15T09:30:00Z",
38            "updated_at": "2024-01-15T09:30:00Z",
39            "sources": null
40          }
41        ]
42      }
43    ]
44  },
45  "pagination": {
46    "total": 127,
47    "offset": 0,
48    "limit": 50
49  }
50}

Returns the run summary plus all requirements with sub-requirements.

Was this page helpful?
Previous

Trigger processing for a check run

Next
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Path parameters

idstringRequiredformat: "uuid"

Response

Check run 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