Start a web chat session

View as Markdown
Mints a short-lived LiveKit access token and creates a room the browser client can join to have a text-first chat with the agent. The response includes the room name, the LiveKit host to connect to, a `conversationId` for correlation, and a `callId` that shows up in call logs. Pair with the [Web SDK](/voice-agents/developer-guide/client-libraries) to render the session in-browser.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Request

This endpoint expects an object.
agentIdstringRequired
The agent to attach the browser client to.

Response

Session minted. Use token + host on the browser client to join roomName.

statusbooleanOptional
dataobjectOptional

Errors

400
Bad Request Error