LiveAvatar
Updated
Integrate LiveAvatar AI avatars into Conversational AI Engine.
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 examples show how to configure a LiveAvatar avatar when starting a conversational AI agent.
from agora_agent import Agent
from agora_agent.agentkit.vendors import LiveAvatarAvatar
# client is your configured Agora client
agent = (
Agent(client)
.with_stt(...) # configure your STT vendor
.with_llm(...) # configure your LLM vendor
.with_tts(...) # configure a TTS vendor at 24000 Hz
.with_avatar(LiveAvatarAvatar(
api_key='your-liveavatar-key',
quality='high',
agora_uid='<avatar_rtc_uid>',
avatar_id='65f9e3c9-d48b-4118-b73a-4ae2e3cbb8f0',
))
)import { Agent, LiveAvatarAvatar } from 'agora-agents';
// client is your configured Agora client
const agent = new Agent({ client })
.withStt(/* configure your STT vendor */)
.withLlm(/* configure your LLM vendor */)
.withTts(/* configure a TTS vendor at 24000 Hz */)
.withAvatar(new LiveAvatarAvatar({
apiKey: 'your-liveavatar-key',
quality: 'high',
agoraUid: '<avatar_rtc_uid>',
avatarId: '65f9e3c9-d48b-4118-b73a-4ae2e3cbb8f0',
}));import "github.com/AgoraIO/agora-agents-go/v2/agentkit/vendors"
// client is your configured Agora client
agent := agentkit.NewAgent(client).WithStt(/* configure your STT vendor */).
WithLlm(/* configure your LLM vendor */).
WithTts(/* configure a TTS vendor at 24000 Hz */).
WithAvatar(
vendors.NewLiveAvatarAvatar(vendors.LiveAvatarAvatarOptions{
APIKey: "your-liveavatar-key",
Quality: "high",
AgoraUID: "<avatar_rtc_uid>",
AvatarID: "65f9e3c9-d48b-4118-b73a-4ae2e3cbb8f0",
}),
)Use the following avatar configuration in your request:
"avatar": {
"vendor": "liveavatar",
"enable": true,
"params": {
"agora_token": "<avatar_rtc_token>",
"agora_uid": "<avatar_rtc_uid>",
"quality": "high",
"avatar_id": "65f9e3c9-d48b-4118-b73a-4ae2e3cbb8f0",
"api_key": "<liveavatar_key>"
}
}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
api_keystringThe API key used for authentication with LiveAvatar's services. Get your API key from the LiveAvatar console.
qualitystring- Possible values
lowmedium 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_uidstringThe unique identifier for the avatar's RTC connection. This must be different from other participants in the channel.
agora_tokenstringThe RTC token that authorizes the avatar to join the video channel. Generate this token using your Agora project credentials.
avatar_idstringThe unique identifier for the avatar you want to use.
disable_idle_timeoutboolean- Default value
- false
Whether to disable the idle timeout feature.
activity_idle_timeoutinteger- Default value
- 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.