Create a compliance check run | Pyramid AI

curl -X POST https://api.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": "Verify that all fire extinguishers are inspected and tagged according to the latest safety standards."
    },
    {
      "text": "Ensure emergency exit routes are clearly marked and unobstructed."
    }
  ]
}'

{
  "request_id": "req_9f8b7c6d-1234-4e56-8a9b-0c1d2e3f4a5b",
  "success": true,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Q4 Safety Audit",
    "org_id": "org_ais",
    "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "pending",
    "total_requirements": 2,
    "created_at": "2024-09-25T14:45:00Z",
    "updated_at": "2024-09-25T14:45:00Z",
    "description": "Quarterly audit checking all fire safety requirements against project documentation",
    "project_name": "Corporate Headquarters Renovation",
    "processed_requirements": 0,
    "passed_requirements": 0,
    "failed_requirements": 0,
    "processing_started_at": "2024-10-01T08:00:00Z",
    "processing_completed_at": "2024-10-01T08:00:00Z"
  },
  "pagination": {
    "total": 127,
    "offset": 0,
    "limit": 50
  }
}

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

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