Base URL
All API endpoints are served under:Authentication
Pass your API key in theX-API-Key request header:
caw CLI.
Response format
Every response is wrapped in a standard envelope:| Field | Type | Description |
|---|---|---|
success | boolean | true on success, false on error. |
result | object | The response payload. |
message | string | Optional human-readable message. |
suggestion | string | Optional hint for agents on how to proceed. |
meta | object | null | Pagination metadata for list endpoints (see below). |
error instead of result:
Pagination
List endpoints support cursor-based pagination viaafter and before query parameters, and an optional limit.
| Parameter | Description |
|---|---|
limit | Maximum number of items to return. |
after | Return items after this cursor (next page). |
before | Return items before this cursor (previous page). |
meta field of the response:
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 HTTP403 with a machine-readable error body. See Handle policy denial for the full error structure and retry patterns.