Skip to main content

​
Base URL

All API endpoints are served from:

​
Authentication

Every endpoint that returns user data requires an API key. Two header forms are accepted; X-API-Key is recommended.

​
Authorization: Bearer header

Equivalent in every way; useful when you’re routing through middleware that already understands bearer tokens.
The /v1/embed/* endpoints are public and intentionally do not require authentication.

​
Get an API key

  1. Sign up or log in at the
  2. Create an organization and project
  3. Open the project’s API Keys section
  4. Click Create API Key and copy the key — it won’t be shown again

​
Machine-readable resources

For automated integrations and AI-assisted development: The OpenAPI spec is auto-generated from the server source on every release and the page-level reference that follows is rendered directly from it. It is the authoritative reference for endpoint structure; for individual field semantics, defer to the live API response when the two disagree (occasional drift can happen between schema annotations and serialized values).

​
Conventions

See Concepts for the rules every endpoint follows: ID/slug resolution, cursor pagination, error envelope, and pricing weight.