Introduction
Agents
Knowledge Base
Organizations
Analytics
Preview & Voice Selection
Integrations
Get Agent
curl --request GET \
--url https://api.example.com/api/agents/{agent_id} \
--header 'X-API-Key: <x-api-key>' \
--header 'X-Organization-Id: <x-organization-id>'{
"success": true,
"data": {
"agent_id": "agent_a1b2c3d4e5f6",
"agent_name": "Sales Rep",
"language": "EN",
"stt_provider": "deepgram",
"tts_provider": "elevenlabs",
"tts_voice": "21m00Tcm4TlvDq8ikWAM",
"llm_provider": "openai",
"llm_model": "gpt-4o",
"system_prompt": "You are a helpful sales representative...",
"speak_first": true,
"end_call_tool": true,
"llm_temperature": 0.7,
"recording_enabled": true,
"voicemail_detection": false,
"voicemail_response_delay": 2.0,
"custom_tools": [],
"kb_document_ids": [],
"assigned_phone_number_ids": [],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:45:00Z"
}
}
Agents
Get Agent
GET
/
api
/
agents
/
{agent_id}
Get Agent
curl --request GET \
--url https://api.example.com/api/agents/{agent_id} \
--header 'X-API-Key: <x-api-key>' \
--header 'X-Organization-Id: <x-organization-id>'{
"success": true,
"data": {
"agent_id": "agent_a1b2c3d4e5f6",
"agent_name": "Sales Rep",
"language": "EN",
"stt_provider": "deepgram",
"tts_provider": "elevenlabs",
"tts_voice": "21m00Tcm4TlvDq8ikWAM",
"llm_provider": "openai",
"llm_model": "gpt-4o",
"system_prompt": "You are a helpful sales representative...",
"speak_first": true,
"end_call_tool": true,
"llm_temperature": 0.7,
"recording_enabled": true,
"voicemail_detection": false,
"voicemail_response_delay": 2.0,
"custom_tools": [],
"kb_document_ids": [],
"assigned_phone_number_ids": [],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:45:00Z"
}
}
Retrieve the full configuration details of a specific agent.
Headers
Your API key for authentication.
The organization ID.
Path Parameters
The unique identifier of the agent (format:
agent_[a-f0-9]{12,}).Permissions
agents:read(all roles)
Response
Indicates if the request was successful.
The full agent configuration object.
Show properties
Show properties
Unique agent identifier.
The name of the agent.
Primary language code (e.g.,
EN, ES).Speech-to-Text provider (e.g.,
deepgram, 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 defining the agent’s persona.
Whether the agent speaks first when call connects.
Whether the end call tool is enabled.
LLM temperature setting (0.0 to 2.0).
Fallback LLM provider.
Fallback LLM model.
Whether call recording is enabled.
Whether answering machine detection is enabled.
Message to leave on voicemail.
Delay in seconds before leaving voicemail message (1.0-5.0).
List of attached tool IDs.
List of attached knowledge base document IDs.
List of assigned phone number IDs.
ISO 8601 timestamp of creation.
ISO 8601 timestamp of last update.
{
"success": true,
"data": {
"agent_id": "agent_a1b2c3d4e5f6",
"agent_name": "Sales Rep",
"language": "EN",
"stt_provider": "deepgram",
"tts_provider": "elevenlabs",
"tts_voice": "21m00Tcm4TlvDq8ikWAM",
"llm_provider": "openai",
"llm_model": "gpt-4o",
"system_prompt": "You are a helpful sales representative...",
"speak_first": true,
"end_call_tool": true,
"llm_temperature": 0.7,
"recording_enabled": true,
"voicemail_detection": false,
"voicemail_response_delay": 2.0,
"custom_tools": [],
"kb_document_ids": [],
"assigned_phone_number_ids": [],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:45:00Z"
}
}
⌘I