API reference
The full REST surface, generated from the OpenAPI spec.
The pages in this section are generated from the platform's OpenAPI spec —
the same contract you can download at GET /api/v1/openapi.json and generate
a typed client from. Every endpoint page includes request/response schemas,
multi-language code samples, and an interactive playground.
Authentication
Most endpoints authenticate with your tenant API key in the x-api-key
header. Provider endpoints use the provider key in x-provider-key.
A handful of in-call endpoints accept a participant token as a Bearer
token, and a few (public room info, branding, public join) need no credential
at all. See Authentication & credentials for
where each credential belongs.
Conventions
- Paths are versioned: everything lives under
/api/v1. - List endpoints are paginated with
page/limitquery parameters. - Errors carry a stable
code— see Error codes. - Requests are throttled per API key at your plan's requests-per-minute limit — see Plans, limits & rate limiting.