Meet Sessions

Start a realtime web session with an AI agent through a public meet link. The visitor exchanges a rotating code for a short-lived access grant, then starts a session.

1. Verify the meet code

Exchange the visitor-entered code for an access grant.

Endpoint

Request Body

code
string
required
The code the visitor entered (from the meet page or link)

Example Request

Response

The access_grant is valid for 15 minutes and must be passed to the sessions endpoint. Codes rotate automatically based on the meet deployment’s rotation schedule.

2. Create a session

Endpoint

Request Body

access_grant
string
Required when the deployment uses a rotating code or rotating_code access mode
locale
string
Language/locale hint for the session (e.g. en, ha)
localised_currency
string
Currency code used for any localized pricing in the session
video_input_enabled
boolean
Whether the visitor wants to enable camera input (only allowed if the deployment permits it)
metadata
object
Arbitrary key-value metadata attached to the session

Example Request

Response

Connect to the returned ws_url with the client_token and stream audio from the client. When the deployment is configured with an avatar, delivery_mode is "avatar" and the session returns avatar configuration instead. For a workflow Meet, delivery_mode describes the deployment-level initial mode only. The workflow may attach, replace, or disable an avatar later through its Start, Agent, and Subagent avatar scopes. Clients should continue subscribing to room video tracks for the duration of the session.

Errors