Base URL
Send production requests to:
Resource endpoints use the /v1 path prefix.
Contract version
The current API contract version is 2026-07-31. Responses include:
The v1 URL prefix identifies the major API surface. The date identifies the deployed contract revision. Clients do not need to send a version header.
Content types
Send JSON request bodies with:
The API returns JSON except for 204 No Content responses and the downloadable OpenAPI document.
Rate limits
Each API key may make 100 requests per minute. When a key exceeds the limit, the API returns 429 RATE_LIMIT_EXCEEDED.
Rate-limited responses include Retry-After and standard rate-limit headers. Wait until the window resets before retrying.
Cache stable resources, use the maximum practical page size, and avoid polling when a webhook can notify your application.
Resource identifiers
API resource IDs are 24-character hexadecimal strings. Treat IDs as opaque strings even when their current format is recognizable.
Many resources also include a public_id. Use the id field for public API paths unless an endpoint explicitly says otherwise.
Timestamps
Timestamps use ISO 8601 date-time strings in UTC:
OpenAPI document
Download the canonical OpenAPI 3.1 contract without authentication:
You can use the document to generate typed clients, validate requests, or import the API into development tools.
