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

Create a compliance check run

POST
/api/v2/check/runs
POST
/api/v2/check/runs
$curl -X POST https://api-staging.pyramid-ai.com/api/v2/check/runs \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
>  "name": "Q4 Safety Audit",
>  "requirements": [
>    {
>      "text": "Ensure all fire extinguishers are inspected and tagged according to safety regulations."
>    }
>  ]
>}'
1{
2  "request_id": "req_9f8e7d6c5b4a3e2f1d0c",
3  "success": true,
4  "data": {
5    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
6    "name": "Q2 2026 Fire Safety Audit",
7    "org_id": "org_ais",
8    "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
9    "status": "pending",
10    "total_requirements": 1,
11    "created_at": "2024-01-10T08:00:00Z",
12    "updated_at": "2024-01-10T08:00:00Z",
13    "description": "Quarterly audit checking all fire safety requirements against project documentation",
14    "project_name": "Downtown Office Renovation",
15    "processed_requirements": 0,
16    "passed_requirements": 0,
17    "failed_requirements": 0,
18    "processing_started_at": "2024-01-15T09:30:00Z",
19    "processing_completed_at": "2024-01-15T09:30:00Z"
20  },
21  "pagination": {
22    "total": 127,
23    "offset": 0,
24    "limit": 50
25  }
26}

Creates an analysis run with multiple requirements. Call POST /check/runs/{id}/trigger to start processing.

Was this page helpful?
Previous

Verify a single compliance requirement

Next
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Request

This endpoint expects an object.
project_idstringRequiredformat: "uuid"
namestringRequired1-200 characters
requirementslist of objectsRequired
handbook_idslist of stringsOptional

Response

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

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error