Skip to main content

Base URL

All traffic is HTTPS only; streaming uses WSS.

Authentication

Pass your API key in the Authorization header for HTTP requests:
For WebSocket connections, pass the key as the token query parameter in the connection URL. See Authentication for full details and key management.

Response envelope

Every response — success or error — shares a common envelope structure. Success
Error
The error.details field may appear on validation errors to provide per-field context; it is optional and omitted when not applicable.

Request IDs

Every response includes a request_id — a 26-character ULID that uniquely identifies your request. Include it when contacting support; it lets us trace your exact request through our systems.

HTTP status codes

For full error codes and handling guidance, see Errors.