Conventions
Base URL, JSON rules, id formats, timestamps, time windows, micro-USD amounts, and CORS.
Request ids
The
x-request-id header: sending your own, reading it back, and quoting it when you report an issue.Scopes
Which scope each route demands, and which scopes each organization role holds.
Errors
The error envelope, what each HTTP status means, plain-text rejections, and how to retry safely.
Problem codes
Every error code, its HTTP status, whether a retry can help, and the page that explains it.
Limits
Body size, question and schema bounds, deadlines, spend ceilings, list sizes, and period quotas.
Changelog
Dated changes to the API contract.
API reference
Every endpoint, generated from the OpenAPI document the server publishes.
At a glance
Related
- Quickstart - send your first run before you need the rules.
- Error handling - turn the error rules into client code.
- Scopes and roles - choose the least privilege a key needs.
- API reference - request and response schemas for every endpoint.