Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.liveavatar.com/llms.txt

Use this file to discover all available pages before exploring further.

​
1. Starting a Session

  1. Generate a session token configured for FULL Mode on your backend
  2. Pass the token to your frontend application
  3. Call the start session endpoint
  4. Establish a WebRTC connection to the LiveAvatar-managed room
Make sure the session token has mode set to "FULL". Token configuration determines which mode initializes.

​
2. Managing the Session

​
Session participants

A FULL Mode session is a LiveKit room with three participants: the end user, the LiveAvatar agent, and the avatar. The agent and avatar are both managed by LiveAvatar — they join the room on your behalf.

​
Session initialization

A session is fully initialized once all three conditions are met:
  1. The room is created
  2. The avatar joins the room
  3. The LiveAvatar agent joins the room
The agent’s responsibility is to manage the room and process events. It consumes everything happening inside the LiveKit room and drives the avatar to reflect it.

​
Event-driven control

After connecting to the room, session management is entirely event-driven. You control the session by sending and receiving events through LiveKit data channels. Events let you:
  • Track speaker state (user speaking, avatar speaking)
  • Capture transcript data
  • Control avatar behaviors (interrupt, idle, listening)
  • Direct avatar responses and audio input processing
We recommend making your frontend the primary controller for emitting events from the LiveKit room — this minimizes latency between user interactions and avatar responses. Event data can be relayed to your backend for downstream processing, logging, and analytics.

​
3. Ending the Session

When the session ends:
  1. The LiveKit room closes
  2. The avatar leaves the room
  3. The user is removed if still present
  4. External resources are cleaned up
You can end a session by calling the Stop Session endpoint or by the session timing out.

​
Next steps

  • Configuration — customize avatar, voice, context, and interactivity
  • Events — full reference of command and response events