Skip to navigation
API referenceVoice

Mint a voice-session token

For a private expert, server-side; hand the token to your own frontend (LiveKit client). variables fill the persona’s {{placeholders}}.

Needs the voice_sessions:write scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
agentIdstringRequired
A UUID.
conversationIdstringOptional
Continue an earlier conversation by voice.
variablesmap from strings to stringsOptional

Up to 20; keys ^[a-z][a-z0-9_]31$.

Response

OK
serverUrlstring

The voice server URL (wss://…).

roomNamestring
participantTokenstring
The LiveKit access token for this one session.

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
429
Too Many Requests Error