Skip to main content

Base URL

All API endpoints are served under:

Authentication

Pass your API key in the X-API-Key request header:
API keys are scoped to a principal and optionally to a pact. To create one, use the Create API key endpoint or the caw CLI.

Response format

Every response is wrapped in a standard envelope:
On error, the envelope uses error instead of result:

Pagination

List endpoints support cursor-based pagination via after and before query parameters, and an optional limit. Cursors are returned in the meta field of the response:
To fetch the next page, pass the returned after value as the after parameter in your next request. When has_more is false, you have reached the end of the list.

Policy denials

When an operation is blocked by a policy, the API returns HTTP 403 with a machine-readable error body. See Handle policy denial for the full error structure and retry patterns.