Start a web call

Start a browser-based call with one of your agents or workflows. Returns a LiveKit room name, WebSocket URL, and a short-lived client token. Pass these to the LiveKit web client to join the call.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
agent_idstringOptional

Public agent ID to call. Provide either agent_id or workflow_id.

workflow_idstringOptional
Public workflow ID to call.
metadatamap from strings to anyOptional
Optional metadata stored with the call session.

Response

Successful Response
call_idstring
room_namestring
livekit_urlstring
tokenstring

Errors

422
Start Web Call Calls Web Post Request Unprocessable Entity Error