Skip to main content

Request Body

Core

name
string
required
Agent display name
model
string
default:"gpt-4o"
LLM model identifier. Use provider/model format or just model name (see LLM Models)
instructions
string
default:"You are a helpful assistant."
System prompt that defines the agent’s behavior, personality, and constraints
description
string
default:"null"
Internal description (not shown to end users)
agentType
string
default:"simple"
Agent type: simple, graph, workflow
voiceEnabled
boolean
default:"false"
Enable voice/phone call capabilities
firstMessage
string
default:"null"
Greeting message the agent speaks when a voice call starts
temperature
number
default:"null"
LLM temperature (0.0–2.0). Lower = more deterministic, higher = more creative
maxTokens
integer
default:"null"
Maximum tokens in the LLM response
endCallEnabled
boolean
default:"true"
Allow the agent to end voice calls
maxDurationSeconds
integer
default:"0"
Maximum voice call duration in seconds. 0 = unlimited
noiseCancellation
string
default:"none"
Noise cancellation: none, bvc, krisp

LLM Models

The model field accepts a string in provider/model format, or just the model name for auto-detection.
Subscription Tiers: Trial (default) — limited to gpt-4o-mini and Sarvam models. PAYG (after first top-up) — all models, OCR, and multimodal unlocked. Enterprise — all features including branding removal, teams, observability, and priority support.
Provider auto-detection rules: Or use explicit format: "openai/gpt-4o", "anthropic/claude-3-5-sonnet-20241022".
Groq delivers the fastest LLM inference — 200-400ms TTFT for voice agents. Recommended for low-latency voice calls.
All Sarvam models are available on Trial tier (no top-up needed).

Transcriber (STT)

Speech-to-text configuration. Only used when voiceEnabled is true.
Default provider. Best accuracy and lowest latency for voice agents.
Supports Hindi, Tamil, Telugu, Kannada, Malayalam, Bengali, Marathi, Gujarati, and more.
Free on Trial tier — AssemblyAI STT is included free during trial (no STT charges).

Voice (TTS)

Text-to-speech configuration. Only used when voiceEnabled is true.
Default provider. Low-latency, high-quality voices.Models: aura-2 (default), auraFeatured Voices (Aura-2):Multilingual: Append language code — aura-2-thalia-es (Spanish), aura-2-thalia-de (German), aura-2-thalia-fr (French), aura-2-thalia-nl (Dutch), aura-2-thalia-it (Italian), aura-2-thalia-ja (Japanese).
High-quality, multi-language voices with low latency.Models: sonic-3, sonic-2, sonic-turbo, sonic50+ voices available — fetched dynamically. Use the voice ID from Cartesia’s library.
Premium voice cloning and 100+ voices.Models: eleven_flash_v2_5, eleven_flash_v2, eleven_turbo_v2_5, eleven_turbo_v2, eleven_multilingual_v2Use the voice ID from your ElevenLabs account (premade or cloned voices).
Models: tts-1, tts-1-hd
Model: bulbul:v2
Models: arcana-v3, mist-v2
Models: inworld-tts-1.5-max, inworld-tts-1.5-mini, inworld-tts-1-max, inworld-tts-1

Tools

Array of tool identifiers to attach to the agent.

Knowledge Base

Attach knowledge sources by passing their IDs. Knowledge sources must be created first via the Knowledge API.
Sources are created via the Knowledge API and can be of these types:

Voice Configuration

These sections configure voice call behavior. Only used when voiceEnabled is true.
Controls how the agent handles user interruptions during voice calls.
Configure call recording for voice agents.
Dual-tone multi-frequency (keypad) detection for IVR systems.
Control agent behavior during silence and unresponsive callers.
Enable multi-language support in voice calls.
Automatically generate a summary after each voice call ends.
Receive real-time event notifications for voice calls.

Graph Data

Workflow configuration for graph or workflow agent types. Used with the visual flow editor.
Node Types:

Full Example — Voice Agent with Tools


Full Example — Simple Chat Agent


Response 201

Returns the full agent object with nested configuration (see Get Agent for complete response schema).

Voice configuration

For voice agents, pass a voice object with the cascaded TTS picker, Speech-to-Speech settings (Gemini Live or OpenAI Realtime), noise cancellation, and audio ambience. See the dedicated Voice Config Reference for every field, default, and accepted values.

Errors