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

Generic avatar (Beta)

The generic avatar vendor allows you to integrate a custom avatar provider into the Conversational AI Engine.

Sample configuration​

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


_10
"avatar": {
_10
"vendor": "generic",
_10
"params": {
_10
"api_key": "<AVATAR_API_KEY>",
_10
"api_base_url": "<AVATAR_API_BASE_URL>",
_10
"avatar_id": "<AVATAR_ID>",
_10
"agora_token": "<AGORA_TOKEN>",
_10
"agora_uid": "<AGORA_UID>"
_10
}
_10
}

Key parameters​

paramsrequired
  • api_key stringrequired

    The API key used for authentication with the avatar provider.

  • api_base_url stringrequired

    The base URL of the avatar provider's API endpoint.

  • avatar_id stringrequired

    The unique identifier for the avatar to use.

  • agora_token stringnullable

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

  • agora_uid stringrequired

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