Documentation
API Reference
Documentation
API Reference
Book a meeting
Linkedin
Github
  1. Core concepts
  • Introduction
  • Get started
    • Quickstart
    • Authentication
  • Core concepts
    • Agents
    • Phone numbers
    • Calls
    • Webhooks
  • Webhooks
    • Overview
    • Assistant request
    • Tool calls
    • Status update
    • End of call report
    • Security
  • Guides
    • Campaigns
    • xAI Realtime Integration
    • Voice selection psychology
    • Analysis templates
    • BYOK Setup
    • Call analysis
    • Call Transfers
    • Custom Tools
    • Sip Trunks
    • Tool templates
    • Voicemail detection
    • Autonomous silence detection
    • Billing
    • Error codes
    • Rate limits
    • Troubleshooting
  • Api's
    • Campaigns
    • Agents
    • Voices
    • BYOK
    • Analysis templates
    • Tool templates
    • Organization
    • Phone numbers
    • Sip trunks
    • Calls
    • Call control
    • Usage
    • Domains
Documentation
API Reference
Documentation
API Reference
Book a meeting
Linkedin
Github
  1. Core concepts

Agents

Agents are AI-powered voice assistants that handle phone conversations. Each agent has its own personality, knowledge, and capabilities defined through configuration.

Agent Components#

An agent consists of three main AI components:

Speech-to-Text (STT)#

Converts the caller's speech to text. Currently powered by Deepgram.
{
  "stt_config": {
    "provider": "deepgram",
    "model": "nova-3-general",
    "language": "nl",
    "keyterms": ["ja", "nee", "oké"]
  }
}
FieldDescription
providerSTT provider (deepgram)
modelModel name (e.g., nova-3-general)
languageLanguage code (e.g., nl, en)
keytermsOptional array of words to boost recognition accuracy

Language Model (LLM)#

The brain of your agent. Processes the conversation and generates responses.
{
  "llm_config": {
    "provider": "openai",
    "model": "gpt-4o-mini",
    "temperature": 0.7,
    "messages": [
      {
        "role": "system",
        "content": "Je bent een vriendelijke klantenservice medewerker..."
      }
    ],
    "tools": []
  }
}
FieldDescription
providerLLM provider (openai, anthropic, groq)
modelModel name (e.g., gpt-4o-mini, claude-3-sonnet)
temperatureResponse randomness (0-2, default 0.7)
messagesSystem prompts defining agent behavior
toolsCustom tools the agent can use (see Custom Tools)

Text-to-Speech (TTS)#

Converts the agent's text responses to speech.
{
  "tts_config": {
    "provider": "elevenlabs",
    "model": "eleven_flash_v2_5",
    "voice_id": "21m00Tcm4TlvDq8ikWAM",
    "language": "nl",
    "stability": 0.5,
    "similarity_boost": 0.75,
    "use_speaker_boost": true
  }
}
Available Providers:
ProviderDescriptionAccess
localCost-efficient Piper TTS (96 voices, 35+ languages)All users
openaiOpenAI TTS with natural voicesAll users
elevenlabsHigh-quality voice cloning and natural speechAll users
cartesiaUltra-low latency TTSAll users
Common Fields:
FieldDescription
providerTTS provider
voice_idVoice identifier (snake_case)
languageLanguage code (e.g., nl, en)
modelModel name (provider-specific)
ElevenLabs-specific:
FieldDescription
stabilityVoice consistency (0-1, default 0.5)
similarity_boostVoice similarity to original (0-1, default 0.75)
use_speaker_boostEnhance speaker clarity (boolean)
speedSpeech speed multiplier
styleSpeaking style intensity (0-1)

Agent Properties#

PropertyTypeDescription
idUUIDUnique identifier (auto-generated)
namestringDisplay name for the agent
business_namestringBusiness the agent represents
notification_emailemailEmail for call notifications
first_messagestringInitial greeting when call starts
is_activebooleanWhether agent can handle calls
voicemail_detectionbooleanAutomatically detect voicemail
voicemail_messagestringMessage to leave on voicemail
max_duration_secondsnumberMaximum call duration (null = unlimited)
autonomous_silence_handlingbooleanAuto-detect silence and prompt caller
webhook_urlURLEndpoint for webhook events
webhook_secretstringSecret for signature verification
webhook_eventsarrayEvents to send to webhook
analysis_planobjectPost-call analysis configuration

Creating an Agent#

Only the name is required. All other fields have sensible defaults.
Minimal agent:
Full agent:
See Create a New Agent for complete API documentation.

Updating an Agent#

Use PATCH to update specific fields. Only provided fields are updated.
See Update an Agent for details.

Deleting an Agent#

When you delete an agent, any phone numbers assigned to it will have their agent_id set to null.
See Delete an Agent for details.

Related#

List All Agents
Get an Agent
Phone Numbers - Assign agents to phone numbers
Webhooks - Configure event notifications
Modified at 2026-01-30 12:18:08
Previous
Authentication
Next
Phone numbers
Built with