Base URL
Authentication
All API requests require awardin_sk_ key in the Authorization header:
Versioning
The API is versioned in the URL path (/api/v1/). Breaking changes (field removal, type change) require a new version with a 6-month deprecation window on the previous version. Adding optional fields is non-breaking and does not require a new version.
Response format
All responses are JSON. Success responses return the resource directly (no wrapper envelope):?cursor=cursor_01j... to fetch the next page. Default page size is 50.
Error format
All errors use the same structured shape:| HTTP status | type | Meaning |
|---|---|---|
| 400 | validation_error | Invalid request body |
| 401 | unauthorized | Missing or invalid API key |
| 403 | forbidden | Key lacks permission for this operation |
| 403 | policy_violation | Request blocked by a policy |
| 404 | not_found | Resource does not exist |
| 429 | budget_exceeded | Monthly budget reached |
| 429 | rate_limit_exceeded | RPM or TPM limit reached |
| 500 | internal_error | Unexpected server error |