List requirements for a check run | Pyramid AI

curl https://api-staging.pyramid-ai.com/api/v2/check/runs/id/requirements \
     -H "Authorization: Bearer <token>"

{
  "request_id": "string",
  "success": null,
  "data": [
    {
      "id": "req_1a2b3c4d-5678-90ab-cdef-123456789012",
      "run_id": "string",
      "text": "Emergency exits must be clearly marked with illuminated signage on every floor",
      "order_index": 0,
      "status": "completed",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "sub_requirements": [
        {
          "id": "string",
          "requirement_id": "string",
          "text": "string",
          "justification": "string",
          "score": 1.1,
          "status": "string",
          "created_at": "2024-01-15T09:30:00Z",
          "updated_at": "2024-01-15T09:30:00Z",
          "sources": null
        }
      ]
    }
  ],
  "pagination": {
    "total": 127,
    "offset": 0,
    "limit": 50
  }
}

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Path parameters

idstringRequiredformat: "uuid"

Response

List of requirements

request_idstringformat: "uuid"

Server-generated per-request UUID. Also sent as X-Request-Id response header. Include in support tickets.

successany

datalist of objects

paginationobject

Present only on list endpoints. Top-level (not nested inside data).

Errors

401

Unauthorized Error

404

Not Found Error

$	curl https://api-staging.pyramid-ai.com/api/v2/check/runs/id/requirements \
>	-H "Authorization: Bearer <token>"

1	{
2	"request_id": "string",
3	"success": null,
4	"data": [
5	{
6	"id": "req_1a2b3c4d-5678-90ab-cdef-123456789012",
7	"run_id": "string",
8	"text": "Emergency exits must be clearly marked with illuminated signage on every floor",
9	"order_index": 0,
10	"status": "completed",
11	"created_at": "2024-01-15T09:30:00Z",
12	"updated_at": "2024-01-15T09:30:00Z",
13	"sub_requirements": [
14	{
15	"id": "string",
16	"requirement_id": "string",
17	"text": "string",
18	"justification": "string",
19	"score": 1.1,
20	"status": "string",
21	"created_at": "2024-01-15T09:30:00Z",
22	"updated_at": "2024-01-15T09:30:00Z",
23	"sources": null
24	}
25	]
26	}
27	],
28	"pagination": {
29	"total": 127,
30	"offset": 0,
31	"limit": 50
32	}
33	}