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

Verify a single compliance requirement

POST
/api/v2/check/verify
POST
/api/v2/check/verify
$curl -X POST https://api-staging.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 installations must comply with AS/NZS 3000 wiring standards"
>}'
1{
2 "request_id": "7f9c2ba4-3e3a-4d2a-9f1e-8b6c9d7e4f12",
3 "success": true,
4 "data": {
5 "verdict": "COMPLIANT",
6 "confidence": 0.92,
7 "evidence": "The project documentation includes detailed wiring diagrams and installation procedures that align with AS/NZS 3000 standards.",
8 "explanation": "The electrical installations have been reviewed and found to meet all mandatory requirements specified in AS/NZS 3000, including safety and performance criteria.",
9 "sources": [
10 {
11 "handbook_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
12 "node_id": "node-4567",
13 "title": "AS/NZS 3000 Wiring Rules Handbook",
14 "start_page": 10,
15 "end_page": 45
16 }
17 ],
18 "handbook": {
19 "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
20 "name": "AS/NZS 3000 Wiring Rules Handbook"
21 },
22 "recommendation": "Maintain regular inspections to ensure ongoing compliance with AS/NZS 3000 standards during future installations."
23 },
24 "pagination": {
25 "total": 1,
26 "offset": 0,
27 "limit": 50
28 }
29}

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

Was this page helpful?
Previous

Get a document by ID

Next
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Request

This endpoint expects an object.
project_idstringRequiredformat: "uuid"
requirementstringRequired<=5000 characters
The compliance requirement to verify against your project documents.
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