Verify a single compliance requirement | Pyramid AI

curl -X POST https://api.pyramid-ai.com/api/v2/check/verify \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "requirement": "All electrical work must comply with AS/NZS 3000"
}'

{
  "request_id": "7f9c2ba4-3e6d-4f8a-9a1b-2c3d4e5f6789",
  "success": true,
  "data": {
    "verdict": "COMPLIANT",
    "confidence": 0.92,
    "evidence": "The project documentation and electrical schematics have been reviewed and found to adhere to the AS/NZS 3000 standards.",
    "explanation": "The electrical installations meet all mandatory safety and performance criteria as outlined in AS/NZS 3000, including wiring methods, circuit protection, and earthing requirements.",
    "sources": [
      {
        "handbook_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "node_id": "node-4567",
        "title": "AS/NZS 3000 Electrical Installations Handbook",
        "start_page": 10,
        "end_page": 45
      }
    ],
    "handbook": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "AS/NZS 3000 Electrical Installations Handbook"
    },
    "recommendation": "Continue regular inspections to ensure ongoing compliance and update documentation with any changes to electrical systems."
  },
  "pagination": {
    "total": 1,
    "offset": 0,
    "limit": 50
  }
}

Synchronous single-shot check. Runs the requirement against the project’s knowledge and returns a verdict with evidence and recommendation. Timeout: 300s.

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Request

This endpoint expects an object.

project_idstringRequiredformat: "uuid"

requirementstringRequired<=5000 characters

handbook_idslist of stringsOptional

Scope to specific handbooks. Omit to use all available.

response_formatenumOptionalDefaults to text

Allowed values:

Response

Verification result

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