Akool
Updated
Integrate Akool AI avatars into Conversational AI Engine.
Akool provides AI-powered avatars with realistic facial expressions and lip-sync capabilities, enabling natural video conversations with your AI agents. Their platform offers a variety of pre-built avatars and supports custom avatar creation.
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 an Akool avatar when starting a conversational AI agent.
from agora_agent import Agent
from agora_agent.agentkit.vendors import AkoolAvatar
# 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 16000 Hz
.with_avatar(AkoolAvatar(
api_key='your-akool-key',
avatar_id='<akool_avatar_id>',
))
)import { Agent, AkoolAvatar } 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 16000 Hz */)
.withAvatar(new AkoolAvatar({
apiKey: 'your-akool-key',
avatarId: '<akool_avatar_id>',
}));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 16000 Hz */).
WithAvatar(
vendors.NewAkoolAvatar(vendors.AkoolAvatarOptions{
APIKey: "your-akool-key",
AvatarID: "<akool_avatar_id>",
}),
)Use the following avatar configuration in your request:
"avatar": {
"vendor": "akool",
"enable": true,
"params": {
"api_key": "<akool_key>",
"agora_uid": "<avatar_rtc_uid>",
"agora_token": "<avatar_rtc_token>",
"avatar_id": "<akool_avatar_id>"
}
}Info
Akool avatars only support audio with a sample rate of 16,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 Akool's services.
Info
To purchase an Akool API key, contact Agora sales.
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 specific Akool avatar you want to use. Find available avatar IDs in your Akool dashboard.