AI Agents
Create Voice Agent
Create a reusable Voice conversation agent with advanced tuning options
POST
Create a Voice agent for AI-powered phone calls. Voice agents support extensive customization for natural conversations.
Voice agents are billed per second of call time. Voicemail detection is enabled by default.
Authorizations
Authentication header containing your API key.
Required Fields
Must be
"voice" for voice agents.Display name for the agent.Example:
"Sales Call Agent"First message spoken when call connects. Supports variables:
{{first_name}}, {{last_name}}Example: "Hi {{first_name}}, this is Sarah calling about your inquiry. Do you have a moment to chat?"AI behavior instructions. Define personality, goals, and conversation flow.Example:
Organization unique_id.
User unique_id (agent creator).
Voice ID for text-to-speech. Get available voices from List Voices.Popular options:
"11labs-Adrian"- Male, American"11labs-Rachel"- Female, American"openai-Alloy"- Neutral, fast
"11labs-Adrian"Language Settings
Language for speech recognition. Options:
| Code | Language |
|---|---|
en-US | English (US) |
en-GB | English (UK) |
es-ES | Spanish (Spain) |
es-419 | Spanish (Latin America) |
fr-FR | French |
de-DE | German |
ja-JP | Japanese |
zh-CN | Chinese |
multi | Multilingual |
Voice Tuning
Fine-tune how the agent sounds and responds.Voice stability. Range:
0 (stable) to 2 (varied).0: Very consistent, robotic1: Balanced (default)2: More expressive, varied
Speech rate. Range:
0.5 (slow) to 2 (fast).0.5: Very slow1: Normal speed (default)2: Very fast
Agent volume. Range:
0 (quiet) to 2 (loud).How quickly agent responds. Range:
0 (slower) to 1 (faster).0: Wait longer before responding1: Respond immediately when possible
How easily user can interrupt. Range:
0 to 1.0: Agent is hard to interrupt1: Agent is easy to interrupt
Ambient Sound
Add background audio for realism.Background ambience. Options:
| Value | Description |
|---|---|
null | No ambient sound |
"coffee-shop" | Café atmosphere |
"convention-hall" | Echo, crowd noise |
"summer-outdoor" | Cicadas, nature |
"mountain-outdoor" | Birds, wind |
"static-noise" | Light static |
"call-center" | Office background |
Ambient sound level. Range:
0 to 2.Backchannel
Enable conversational acknowledgments like “yeah”, “uh-huh” during user speech.Enable conversational interjections.
How often to interject. Range:
0 (rarely) to 1 (frequently).Custom words to use. Comma-separated.Default:
["yeah", "uh-huh"]Example: ["right", "I see", "got it"]Voicemail Detection
Automatically detect voicemail. Enabled by default for outbound campaigns.
Time to wait for detection (milliseconds). Default: 30 seconds.Range:
5000 (5s) to 180000 (3 min)Message to leave on voicemail. If empty, call hangs up when voicemail is detected.Example:
"Hi {{first_name}}, this is Sarah from Acme Corp. Please call us back at 555-1234."Reminder Settings
What happens when user goes silent.Time (ms) to wait before reminding silent user. Default: 10 seconds.
Max reminders before ending call. Set to
0 to disable.End call after this much silence (ms). Default: 90 seconds (1.5 min).Minimum:
10000 (10s)Call Settings
Maximum call length (ms). Default: 1 hour.Range:
60000 (1 min) to 7200000 (2 hours)Delay before speaking (ms). Gives user time to say “hello”.Range:
0 to 5000Ring timeout for outbound calls (ms). Default: 30 seconds.
Speech Recognition
Speech-to-text mode:
"fast": Lower latency, good accuracy"accurate": Higher accuracy, more latency
Vocabulary focus:
"general": General conversations"medical": Medical terminology
Words to boost recognition for (brand names, product names).Example:
["Acme", "TurboWidget", "ProPlan"]Convert numbers/dates to spoken form. E.g., “2024” → “twenty twenty-four”
Advanced Settings
Allow keypad input (press 1, press 2, etc.)
Audio cleanup:
"noise-cancellation": Filter background noise"noise-and-background-speech-cancellation": Also filter other voices
What to store:
"everything": Full transcripts, recordings, logs"everything_except_pii": Scrub PII before storing"basic_attributes_only": No transcripts/recordings
Knowledge Base Integration
Link knowledge bases for RAG retrieval during calls.Example:
["kb_7a0682ce5fc02413"]Knowledge base settings:
Tools / Function Calling
Tools for function calling during calls. See Update Agent Tools.Types:
end_call, transfer_call, custom (calls your endpoint)Data Extraction (Post-Call Analysis)
Automatically extract custom data from call transcripts after each call ends. Results are stored in the call history and available via extraction endpoints.List of field names to extract from conversations. Simple string array that auto-generates extraction instructions.Example:
["credit_score", "loan_amount", "annual_income", "interested", "timeline"]How it works:- During calls, AI collects information naturally through conversation
- After call ends, AI extracts specified fields from transcript
- Results saved to
extracted_fieldsin call history - Accessible via GET /v1/voice/calls//extractions
Recommended Use Cases:
- Lead qualification (budget, timeline, interest level)
- Customer info (email, phone, preferred contact method)
- Order details (product, quantity, shipping address)
- Appointment scheduling (date, time, reason)
Advanced: Define custom fields with specific types and validation. Use Enum Type - Extract from predefined choices:Boolean Type - Extract true/false values:Number Type - Extract numeric values:
extraction_fields for simpler configuration.Supports four data types:String Type - Extract free-form text:If both
extraction_fields and post_call_analysis_data are provided, post_call_analysis_data takes precedence.Response Fields
Agent identifier. Use this when creating voice campaigns.
Internal voice agent ID.
Internal LLM configuration ID.
Configured voice ID.
Whether data extraction is configured for this agent.
List of fields that will be extracted from calls.
Recommended Defaults for Use Cases
Cold Calling / Sales
Customer Support
Appointment Reminders
Next Steps
- List Voices - Browse available voices
- Create Knowledge Base - Add RAG support
- Create Voice Campaign - Launch calls

