Introduction
Agents
Knowledge Base
Copy
{
"config": {
"agent_name": "Sales Rep",
"stt_provider": "deepgram-nova-3",
"tts_provider": "cartesia",
"tts_voice": "f786b574-daa5-4673-aa0c-cbe3e8534c02",
"llm_provider": "google",
"llm_model": "gemini-2.5-flash-lite",
"system_prompt": "You are a helpful sales representative...",
"speak_first": true,
"recording_enabled": true
}
}
Copy
{
"success": true,
"agent": {
"agent_id": "agent_12345",
"agent_name": "Sales Rep",
"stt_provider": "deepgram-nova-3",
"created_at": "2024-01-01T00:00:00Z"
// ... other fields
}
}
Agents
Create Agent
POST
/
api
/
agents
Copy
{
"config": {
"agent_name": "Sales Rep",
"stt_provider": "deepgram-nova-3",
"tts_provider": "cartesia",
"tts_voice": "f786b574-daa5-4673-aa0c-cbe3e8534c02",
"llm_provider": "google",
"llm_model": "gemini-2.5-flash-lite",
"system_prompt": "You are a helpful sales representative...",
"speak_first": true,
"recording_enabled": true
}
}
Copy
{
"success": true,
"agent": {
"agent_id": "agent_12345",
"agent_name": "Sales Rep",
"stt_provider": "deepgram-nova-3",
"created_at": "2024-01-01T00:00:00Z"
// ... other fields
}
}
Create a new AI voice agent with specific configuration for STT, TTS, LLM, and behavior.
Agent configuration object.
Show config properties
Show config properties
The name of the agent.
Speech-to-Text provider (e.g.,
deepgram-nova-3, aws).Text-to-Speech provider (e.g.,
elevenlabs, cartesia, deepgram).Voice ID for the selected TTS provider.
LLM provider (e.g.,
openai, anthropic, google).Model ID (e.g.,
gpt-4o, gemini-2.5-flash-lite).The system prompt that defines the agent’s persona and instructions.
Whether the agent should speak first when the call connects.
Enable the built-in end call tool for the agent.
Temperature setting for the LLM (0.0 to 2.0).
Enable call recording for this agent.
Enable AMD (Answering Machine Detection).
Message to leave if a voicemail is detected.
Delay in seconds before speaking the voicemail message.
List of Custom Tool IDs to attach to this agent.
List of Knowledge Base Document IDs to attach to this agent.
List of Phone Number IDs assigned to this agent.
Response
Indicates if the request was successful.
The created agent object.
Copy
{
"config": {
"agent_name": "Sales Rep",
"stt_provider": "deepgram-nova-3",
"tts_provider": "cartesia",
"tts_voice": "f786b574-daa5-4673-aa0c-cbe3e8534c02",
"llm_provider": "google",
"llm_model": "gemini-2.5-flash-lite",
"system_prompt": "You are a helpful sales representative...",
"speak_first": true,
"recording_enabled": true
}
}
Copy
{
"success": true,
"agent": {
"agent_id": "agent_12345",
"agent_name": "Sales Rep",
"stt_provider": "deepgram-nova-3",
"created_at": "2024-01-01T00:00:00Z"
// ... other fields
}
}
⌘I