Base URL
Authentication
Send your API key as a Bearer token. See Authentication for secret vs publishable keys and test vs live.Conventions
- JSON everywhere. Send
Content-Type: application/json; responses are JSON. - Idempotency. On write requests, send an
Idempotency-Keyheader. A retried request with the same key returns the original result instead of creating a duplicate. - Versioning. The API is versioned in the path (
/v1). Breaking changes ship under a new version.
Errors
Errors use standard HTTP status codes and a consistent body:Rate limits
Requests are limited per API key. When you exceed the limit you receive429
with X-RateLimit-* headers indicating your remaining quota and reset time.
