Skip to main content
POST
create engine session

Authorizations

Authorization
string
header
required

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

Body

application/json
clientLabel
string

Label for the session, recorded for usage attribution. API-key auth only.

personaConfig
object

Session persona configuration (API-key auth only). Same shape as the /v1/auth/session-token request: supply personaId for a persona you've already created, or avatarId/voiceId/llmId/systemPrompt for an ephemeral persona. Inline tools are supported; each client/webhook tool's parameters (and webhook queryParameters) JSON Schema must serialize to 10,000 bytes or less (UTF-8).

environment
object

Optional environment configuration (e.g. LiveKit settings). API-key auth only.

sessionOptions
object

Optional session options (session replay, video quality/dimensions, egress). API-key auth only.

clientMetadata
object

Optional client metadata forwarded to the engine (e.g. supportsPubSubSignalling).

Response

Session started

sessionId
string<uuid>
engineHost
string

Host of the engine serving this session. Omitted for LiveKit/Agora integrations.

engineProtocol
string
signallingEndpoint
string
clientConfig
object
Last modified on July 24, 2026