This reference covers the REST endpoints an integrator uses. Most of your real-time work — sending messages, typing, presence, receipts, call signaling — happens over the WebSocket (usually via the SDK). REST is for provisioning tokens, reading history, and fetching config.
Messages are sent over the WebSocket, not REST. Use client.conversations.get(id).sendMessage(...). REST endpoints are for history and setup.

Base URL

All endpoints are under the /api/v1 prefix. Use your production host in production.

Authentication

Depending on the endpoint, you authenticate with one of: See Authentication & tokens for the full picture. Keys stay on your backend; the browser only ever gets a token.

Response format

Every response is wrapped in a consistent envelope:
Errors use the same shape with success: false and an HTTP status code:

Where to start

Issue SDK Token

Mint a token for a known user.

Start a Support Session

Token + support conversation in one call.

Open an Anonymous Session

Browser-only provisioning with a public key.

Get ICE Servers

STUN/TURN config for voice/video.