Skip to main content
Conversational AI Engine: Create advanced voice apps by combining Agora's real-time audio with powerful conversational AI.

LiveAvatar

LiveAvatar by HeyGen provides AI-powered avatars with high-quality video rendering and customizable video quality settings, enabling professional video conversations with your AI agents.

info

This integration is fully supported for use with Conversational AI Engine. While it has completed functional validation, it is newer to the platform, and additional provider-specific edge cases may be identified as usage scales across a broader range of applications and workloads.

Sample configuration​

The following example shows a starting avatar parameter configuration you can use when you Start a conversational AI agent.


_11
"avatar": {
_11
"vendor": "liveavatar",
_11
"enable": true,
_11
"params": {
_11
"agora_token": "<avatar_rtc_token>",
_11
"agora_uid": "<avatar_rtc_uid>",
_11
"quality": "high",
_11
"avatar_id": "65f9e3c9-d48b-4118-b73a-4ae2e3cbb8f0",
_11
"api_key": "<liveavatar_key>",
_11
}
_11
}

info

LiveAvatar only support audio with a sample rate of 24,000 Hz. Using a TTS model configured with a different sample rate will result in an error. Ensure your TTS configuration matches this requirement.

Key parameters​

paramsrequired
  • api_key stringrequired

    The API key used for authentication with LiveAvatar's services. Get your API key from the LiveAvatar console.

  • quality stringrequired

    Possible values: low, medium high

    The video quality for the avatar rendering.

    • "high" (720p)
    • "medium" (480p)
    • "low" (360p).

    Higher quality provides better visual experience but requires more bandwidth.

  • agora_uid stringrequired

    The unique identifier for the avatar's RTC connection. This must be different from other participants in the channel.

  • agora_token stringnullable

    The RTC token that authorizes the avatar to join the video channel. Generate this token using your Agora project credentials.

  • avatar_id stringnullable

    The unique identifier for the avatar you want to use.

  • disable_idle_timeout booleannullable

    Default: false

    Whether to disable the idle timeout feature.

  • activity_idle_timeout integernullable

    Default: 120

    The number of seconds of inactivity before the avatar session times out. Only applies when disable_idle_timeout is false.

For advanced configuration options, refer to the LiveAvatar official documentation.