v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-304917042.1 MB
voice

Web Call

Mint a LiveKit access token + auto-dispatch directive for a browser call.

The browser passes the returned access_token to livekit-client's connect(livekit_url, access_token). LiveKit creates the room and auto-dispatches the voice-worker into it; agent_id is JWT-signed and tamper-proof. The supervisor selects which enabled procedure runs from the agent's active-revision catalog on turn 1. The session is created with session_type="test" so post-processing (summary, memory sync) is skipped.

post/v1/voice/web-call

Request body

agent_idstring uuid nullable

Agent whose VoicePipelineConfig drives the call. Provide this XOR team_id.

team_idstring uuid nullable

Team to test against — the team-level VoicePipelineConfig drives the call and the team's default active agent (initial member) answers/greets. Provide this XOR agent_id.

context_variablesobject nullable

Optional seed values for the bound agent's typed context variables, applied once at session bootstrap (same contract as the outbound-call door). Unknown key / uncoercible value → 422. Single-agent bindings only in v1 (ignored for team-bound test calls).

Response

Successful Response

livekit_urlstring required

wss:// URL the browser passes to livekit-client.connect().

access_tokenstring required

Short-lived (5 min) LiveKit JWT. Embeds RoomAgentDispatch so the voice-worker auto-joins when the browser connects.

room_namestring required
session_idstring uuid required