Skip to main content
POST
Start a voice session

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

Body

application/json
conversationId
string<uuid>

Optional conversation UUID. Reuse a value to group multiple voice sessions into one conversation in chat logs. If omitted, a new conversation is created. A conversation belongs to the end-user who started it: when reusing, send that same userId or omit userId to inherit it; a different userId is rejected with CONVERSATION_USER_MISMATCH.

userId
string

Your end-user ID. Send a stable ID so per-user voice limits apply; if omitted a random one is generated per session (or inherited from the conversation when reusing a conversationId). Sessions with the same userId but no conversationId are separate conversations owned by the same end-user. Must contain only URL-safe characters (letters, digits, hyphens, underscores, dots).

Maximum string length: 128
Pattern: ^[a-zA-Z0-9._-]+$
timezone
string
default:UTC

IANA timezone of the end user (e.g. "Europe/Paris"), used by the agent for time-aware answers. Defaults to UTC.

Maximum string length: 64

Response

Voice session created

data
object
required