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

Trigger processing for a check run

POST
/api/v2/check/runs/:id/trigger
POST
/api/v2/check/runs/:id/trigger
$curl -X POST https://api-staging.pyramid-ai.com/api/v2/check/runs/id/trigger \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "request_id": "string",
3  "success": null,
4  "data": {
5    "run_id": "string",
6    "task_id": "string",
7    "status": "processing"
8  },
9  "pagination": {
10    "total": 127,
11    "offset": 0,
12    "limit": 50
13  }
14}

Starts or re-starts processing for the given run. Returns immediately with a task ID — poll GET /check/runs/{id} for status updates.

Was this page helpful?
Previous

List compliance check runs

Next
Built with

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
reprocessbooleanOptionalDefaults to false

Re-process all requirements even if already completed

skip_breakdownbooleanOptionalDefaults to false

Skip sub-requirement breakdown step

Response

Processing triggered
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

401
Unauthorized Error
404
Not Found Error
409
Conflict Error