curl --request GET \
--url https://api.telleo.ai/v1/agents/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.telleo.ai/v1/agents/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.telleo.ai/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Get an agent
With agents:manage, the agent’s whole configuration including its script (configuration: "full"). With only calls:read, a summary without system_prompt, handoff_numbers, send_rules and booking_page_id (configuration: "summary").
Scope: calls:read.
curl --request GET \
--url https://api.telleo.ai/v1/agents/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.telleo.ai/v1/agents/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.telleo.ai/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Authorizations
Your AI calling API key (vak_call_…). Authorization: Bearer <key> also works.
Path Parameters
Response
The agent.
"agent"Unique in your account, ignoring case.
128outbound places calls, inbound answers your numbers, both does both.
outbound, inbound, both hinglish, hindi, english, punjabi, marathi, gujarati, bengali, tamil, telugu, kannada, malayalam, odia, a code (hi) or a tag (hi-IN). null = Hindi or Hinglish.
"hinglish"
Voice engine id from GET /voices. Default for a new agent: google.
A voice of tts_model (GET /voices). Changing tts_model needs a voice of the new engine.
The first thing the agent says. {{placeholders}} are filled per call.
2000The agent's script and instructions.
60000Questions whose answers come back in outcome.answers.
50500Labels the agent may give a call. Empty = your account's defaults.
5064E.164 numbers the agent can transfer a caller to.
10null = 10 minutes.
1 <= x <= 30Speaking rate; null = default.
0.5 <= x <= 2Voice expressiveness; null = engine default.
0.01 <= x <= 2Pitch-range expansion; null = off.
1 <= x <= 2.5A booking page of your account the agent books on.
This is your account's default agent (GET /settings/default-agent).
Read-only; set by support.
off, fixed, full summary for a key without agents:manage: system_prompt, handoff_numbers, send_rules and booking_page_id are left out.
full, summary On disable (and a PATCH of enabled): calls that were waiting for this agent and were canceled.
Non-fatal notes about what was (not) done, e.g. mobile_number_missing.
Show child attributes
Show child attributes