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>'import requests
url = "https://api.example.com/api/agents/{agent_id}"
headers = {
"X-API-Key": "<x-api-key>",
"X-Organization-Id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-Key': '<x-api-key>', 'X-Organization-Id': '<x-organization-id>'}
};
fetch('https://api.example.com/api/agents/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>",
"X-Organization-Id: <x-organization-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/agents/{agent_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("X-Organization-Id", "<x-organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/agents/{agent_id}")
.header("X-API-Key", "<x-api-key>")
.header("X-Organization-Id", "<x-organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
request["X-Organization-Id"] = '<x-organization-id>'
response = http.request(request)
puts response.read_body{
"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>'import requests
url = "https://api.example.com/api/agents/{agent_id}"
headers = {
"X-API-Key": "<x-api-key>",
"X-Organization-Id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-Key': '<x-api-key>', 'X-Organization-Id': '<x-organization-id>'}
};
fetch('https://api.example.com/api/agents/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>",
"X-Organization-Id: <x-organization-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/agents/{agent_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("X-Organization-Id", "<x-organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/agents/{agent_id}")
.header("X-API-Key", "<x-api-key>")
.header("X-Organization-Id", "<x-organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
request["X-Organization-Id"] = '<x-organization-id>'
response = http.request(request)
puts response.read_body{
"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
string
required
Your API key for authentication.
string
required
The organization ID.
Path Parameters
string
required
The unique identifier of the agent (format:
agent_[a-f0-9]{12,}).Permissions
agents:read(all roles)
Response
boolean
Indicates if the request was successful.
object
The full agent configuration object.
Show properties
Show properties
string
Unique agent identifier.
string
The name of the agent.
string
Primary language code (e.g.,
EN, ES).string
Speech-to-Text provider (e.g.,
deepgram, aws).string
Text-to-Speech provider (e.g.,
elevenlabs, cartesia, deepgram).string
Voice ID for the selected TTS provider.
string
LLM provider (e.g.,
openai, anthropic, google).string
Model ID (e.g.,
gpt-4o, gemini-2.5-flash-lite).string
The system prompt defining the agent’s persona.
boolean
Whether the agent speaks first when call connects.
boolean
Whether the end call tool is enabled.
number
LLM temperature setting (0.0 to 2.0).
string
Fallback LLM provider.
string
Fallback LLM model.
boolean
Whether call recording is enabled.
boolean
Whether answering machine detection is enabled.
string
Message to leave on voicemail.
number
Delay in seconds before leaving voicemail message (1.0-5.0).
array
List of attached tool IDs.
array
List of attached knowledge base document IDs.
array
List of assigned phone number IDs.
string
ISO 8601 timestamp of creation.
string
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