Protoface
Updated
Integrate Protoface AI avatars into Conversational AI Engine.
Protoface provides real-time AI avatars that add a talking, lip-synced face to your voice agents, enabling natural video conversations with your AI agents.
Sample configuration
The following examples show how to configure a Protoface avatar when starting a conversational AI agent.
from agora_agent import Agent
from agora_agent.agentkit.vendors import Protoface
# client is your configured Agora client
agent = (
Agent(client)
.with_stt(...) # configure your STT vendor
.with_llm(...) # configure your LLM vendor
.with_tts(...) # configure your TTS vendor
.with_avatar(Protoface(
api_key='<PROTOFACE_API_KEY>',
api_base_url='https://api.protoface.com/v1/agora',
avatar_id='<PROTOFACE_AVATAR_ID>',
agora_uid='<AGORA_UID>',
))
)import { Agent, Protoface } 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 your TTS vendor */)
.withAvatar(new Protoface({
apiKey: '<PROTOFACE_API_KEY>',
apiBaseUrl: 'https://api.protoface.com/v1/agora',
avatarId: '<PROTOFACE_AVATAR_ID>',
agoraUid: '<AGORA_UID>',
}));import (
"github.com/AgoraIO/agora-agents-go/v2/agentkit"
"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 your TTS vendor */).
WithAvatar(
vendors.NewProtoface(vendors.ProtofaceOptions{
APIKey: "<PROTOFACE_API_KEY>",
APIBaseURL: "https://api.protoface.com/v1/agora",
AvatarID: "<PROTOFACE_AVATAR_ID>",
AgoraUID: "<AGORA_UID>",
}),
)Set vendor to generic and use the following avatar configuration in your request:
"avatar": {
"vendor": "generic",
"params": {
"api_key": "<PROTOFACE_API_KEY>",
"api_base_url": "https://api.protoface.com/v1/agora",
"avatar_id": "<PROTOFACE_AVATAR_ID>",
"agora_token": "<AGORA_TOKEN>",
"agora_uid": "<AGORA_UID>"
}
}Key parameters
api_keystringThe API key used for authentication with Protoface. Get your API key from the Protoface dashboard.
api_base_urlstringThe base URL of the Protoface API endpoint. Set to https://api.protoface.com/v1/agora.
avatar_idstringThe ID of the Protoface avatar to use, for example, av_stock_001. Find a stock avatar or create your own in the Protoface dashboard.
agora_tokenstringThe RTC token that authorizes the avatar to join the video channel. Generate this token using your Agora project credentials.
agora_uidstringThe unique identifier for the avatar's RTC connection. This must be different from other participants in the channel.
For more information about avatars, refer to the Protoface avatar documentation. For a complete working project, see the Protoface Agora quickstart.
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.