Skip to main content
POST
Mint a LiveKit token for a web call

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Body

application/json
assistantId
string<uuid>
required

The assistant's uuid, shown on its configure page in the console. Names and slugs are not accepted.

engine
enum<string>
Available options:
cascade,
s2s
overrides
object

Transient AssistantConfig overrides for this call only.

contactRef
string<uuid>

An account (contact) id. The agent's {{tokens}} that the request leaves blank are filled from that contact, as on an outbound call. The call is not tagged with the contact: it does not appear on their timeline or in the end-of-call webhook. Requires contacts:read, runs the saved agent (no overrides or engine), and always returns a sealed config in the token.

Response

Token and the cells this client may connect to.

livekitUrl
string
Example:

"wss://…"

cells
object[]
token
string

LiveKit JWT.

room
string
Example:

"console-1a2b3c4d"

engine
enum<string>
Available options:
cascade,
s2s