Configuration

This mode offers customization for two main areas: avatars and WebRTC configuration.

Avatars

Each avatar is identified by a unique avatar_id. LiveAvatar offers a catalog of avatars ranging from realistic human presenters to stylized or expressive characters. Browse available avatars through the List Public Avatars or List User Avatars endpoints.

WebRTC Configuration

LiveKit (default)

By default, LiveAvatar creates a LiveKit room and provides an agent token. You configure your own ASR, LLM, and TTS stack with a custom LiveKit Agent.

Bring your own infrastructure

You can provide your own WebRTC setup using:

Agora — configured via the agora_config parameter
LiveKit — configured via the livekit_config parameter

When using custom infrastructure, LiveAvatar streams the avatar video directly into your WebRTC setup.

Example

{
  "mode": "LITE",
  "avatar_id": "<avatar_id>",
  "video_settings": {
    "quality": "high",
    "encoding": "H264"
  }
}

encoding: "VP8" is deprecated and will be removed in a future release. Use H264 (the default).

With custom LiveKit infrastructure:

{
  "mode": "LITE",
  "avatar_id": "<avatar_id>",
  "livekit_config": {
    "url": "wss://your-livekit-server.com",
    "token": "<your_agent_token>"
  }
}

Getting Started

Core Concepts

FULL Mode

Avatar Only (LITE mode)

Socials

FAQ

Avatars

WebRTC Configuration

LiveKit (default)

Bring your own infrastructure

Example

​Avatars

​WebRTC Configuration

​LiveKit (default)

​Bring your own infrastructure

​Example

Avatars

WebRTC Configuration

LiveKit (default)

Bring your own infrastructure

Example