ElevenLabs
Updated
Use ElevenLabs for text-to-speech (TTS) in a Conversational AI Platform agent.
Preview documentation
ElevenLabs provides highly realistic AI voices with advanced prosody and natural speech patterns, delivering lifelike audio synthesis with emotional nuance and conversational flow.
Paid plan required
You need a paid ElevenLabs plan for reliable TTS integration.
ElevenLabs may restrict or disable free-tier accounts due to abuse-detection mechanisms, even if free credits are available. To avoid missing audio responses during testing and production, ensure you use a paid plan.
Sample configuration
The following example shows how to configure ElevenLabs as the agent's TTS when you create or update an agent. For a complete example, see Create an agent and start a session.
ElevenLabs supports BYOK only. It isn't available in managed mode. Store your ElevenLabs API key in a secret set, and refer to it from the agent. For details, see Use your own provider keys.
from agora_agent import Agent, ElevenLabsTTS, secret_ref
# client is your configured Agora client
agent = (
Agent(client=client)
.with_stt(...) # configure your ASR vendor
.with_llm(...) # configure your LLM vendor
.with_tts(
ElevenLabsTTS(
key=secret_ref("support_prod", "elevenlabs"),
base_url="wss://api.elevenlabs.io/v1",
model_id="eleven_flash_v2_5",
voice_id="pNInz6obpgDQGcFmaJgB",
sample_rate=24000,
)
)
)import { Agent, ElevenLabsTTS, secretRef } from 'agora-agents';
// client is your configured Agora client
const agent = new Agent({ client })
.withStt(/* configure your ASR vendor */)
.withLlm(/* configure your LLM vendor */)
.withTts(
new ElevenLabsTTS({
key: secretRef('support_prod', 'elevenlabs'),
baseUrl: 'wss://api.elevenlabs.io/v1',
modelId: 'eleven_flash_v2_5',
voiceId: 'pNInz6obpgDQGcFmaJgB',
sampleRate: 24000,
}),
);// client is your configured Agora client
sampleRate := vendors.SampleRate24kHz
agent := agentkit.NewAgent(client).
WithStt( /* configure your ASR vendor */ ).
WithLlm( /* configure your LLM vendor */ ).
WithTts(vendors.NewElevenLabsTTS(vendors.ElevenLabsTTSOptions{
Key: agentkit.SecretRef("support_prod", "elevenlabs"),
BaseURL: "wss://api.elevenlabs.io/v1",
ModelID: "eleven_flash_v2_5",
VoiceID: "pNInz6obpgDQGcFmaJgB",
SampleRate: &sampleRate,
}))Set credential.mode to byok and credential.fields.key to a reference to your ElevenLabs API key. In the following example, the key is stored as elevenlabs in the support_prod set:
"tts": {
"credential": {
"mode": "byok",
"fields": {
"key": "$secrets.support_prod.elevenlabs"
}
},
"vendor": "elevenlabs",
"url": "wss://api.elevenlabs.io/v1",
"params": {
"model_id": "eleven_flash_v2_5",
"voice_id": "pNInz6obpgDQGcFmaJgB",
"sample_rate": 24000
}
}Key parameters
The tts block takes the following fields. In the SDKs, ElevenLabsTTS sets them from its options.
| Parameter | Description |
|---|---|
vendorstring | Set to |
credentialobject | Set |
urlstring | The endpoint URL for the ElevenLabs TTS service. See Data residency. |
paramsobject |
|
Caution
The parameters listed on this page are validated for use with the Conversational AI Platform. Required parameters must be provided as documented. Any additional parameters in params are passed through directly to ElevenLabs without validation. For a full list of supported options, refer to the ElevenLabs TTS documentation.
