All endpoints are served under:
Get an API key
Create a key from the API keys page in the Lab. See Get your API key for the full walkthrough. Keep the key on your server. Never ship it to a browser or mobile app.
Authenticate requests
Every request takes a bearer token in the Authorization header:
Connecting clients
Clients don’t use your API key. Your backend creates a short-lived session token with POST /v1/auth/session-token and hands it to the client, which uses it to open a WebRTC stream. See Authentication for a worked server example.
Conventions
- Request and response bodies are JSON. Field names are
camelCase.
- List endpoints accept
page and perPage query parameters and return { data: [...], meta: { total, currentPage, perPage, lastPage, prev, next } }.
Last modified on July 27, 2026
