Skip to main content
The full, interactive endpoint reference is generated from the OpenAPI specification — browse it in the pages under this tab. This page covers the conventions that apply everywhere.

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-Key header. 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 receive 429 with X-RateLimit-* headers indicating your remaining quota and reset time.