curl --request GET \
--url https://api.itellico.ai/v1/accounts/{account_id}/agents/{agent_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.itellico.ai/v1/accounts/{account_id}/agents/{agent_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.itellico.ai/v1/accounts/{account_id}/agents/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.itellico.ai/v1/accounts/{account_id}/agents/{agent_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.itellico.ai/v1/accounts/{account_id}/agents/{agent_id}")
.header("X-API-Key", "<api-key>")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.itellico.ai/v1/accounts/{account_id}/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: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.itellico.ai/v1/accounts/{account_id}/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"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"account_id": "<string>",
"name": "<string>",
"initial_message": {
"message": "",
"mode": "fixed_message",
"delay_ms": 0,
"interruptible": false
},
"ambient_sound": {
"source": "open_plan_office",
"volume": 0.5
},
"inactivity_settings": {
"reminder_timeout_ms": 10000,
"reminder_max_count": 2,
"end_call_timeout_ms": 305000,
"reset_on_activity": true
},
"response_timing": {
"min_endpointing_delay_seconds": 0.1
},
"allow_auto_hangup": true,
"allow_caller_recording_opt_out": true,
"max_duration_seconds": 123,
"note": "<string>",
"tags": [
"<string>"
],
"interrupt_settings": {
"enabled": true,
"min_words": 0,
"min_speech_seconds": 0.2
},
"model": {},
"transcriber": {},
"voice": {},
"metadata": {},
"capture_settings": {
"recording_enabled": true
},
"volume": {
"web": 0.5,
"telephony": 0.5,
"allow_adjustment": true
},
"denoising": {
"web": true,
"telephony": true
},
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}Get an agent
Retrieve detailed information about a specific agent.
curl --request GET \
--url https://api.itellico.ai/v1/accounts/{account_id}/agents/{agent_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.itellico.ai/v1/accounts/{account_id}/agents/{agent_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.itellico.ai/v1/accounts/{account_id}/agents/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.itellico.ai/v1/accounts/{account_id}/agents/{agent_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.itellico.ai/v1/accounts/{account_id}/agents/{agent_id}")
.header("X-API-Key", "<api-key>")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.itellico.ai/v1/accounts/{account_id}/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: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.itellico.ai/v1/accounts/{account_id}/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"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"account_id": "<string>",
"name": "<string>",
"initial_message": {
"message": "",
"mode": "fixed_message",
"delay_ms": 0,
"interruptible": false
},
"ambient_sound": {
"source": "open_plan_office",
"volume": 0.5
},
"inactivity_settings": {
"reminder_timeout_ms": 10000,
"reminder_max_count": 2,
"end_call_timeout_ms": 305000,
"reset_on_activity": true
},
"response_timing": {
"min_endpointing_delay_seconds": 0.1
},
"allow_auto_hangup": true,
"allow_caller_recording_opt_out": true,
"max_duration_seconds": 123,
"note": "<string>",
"tags": [
"<string>"
],
"interrupt_settings": {
"enabled": true,
"min_words": 0,
"min_speech_seconds": 0.2
},
"model": {},
"transcriber": {},
"voice": {},
"metadata": {},
"capture_settings": {
"recording_enabled": true
},
"volume": {
"web": 0.5,
"telephony": 0.5,
"allow_adjustment": true
},
"denoising": {
"web": true,
"telephony": true
},
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}{
"code": "not_found",
"detail": "Agent with UUID 123e4567-e89b-12d3-a456-426614174000 does not exist",
"message": "Resource not found"
}Authorizations
Response
OK
Response returned after agent operations (create, get, update)
Unique identifier for the agent. Use this ID to reference the agent in API calls for updates, deletion, or starting conversations.
Unique identifier for the account that owns this agent.
The display name of the agent as configured. This is for your reference and internal organization.
Configuration for the agent's initial message when starting a conversation.
Show child attributes
Show child attributes
Configuration for ambient background sounds during the conversation.
Show child attributes
Show child attributes
Configuration for handling user inactivity and silence during conversations.
Show child attributes
Show child attributes
Configuration for agent response timing and conversation flow control.
Show child attributes
Show child attributes
Whether the AI may automatically end the call when the conversation has concluded.
Whether callers may request that recording stop and captured audio be deleted.
The maximum conversation duration configured for this agent in seconds. Maximum allowed is 7200 seconds (2 hours).
Internal notes about the agent for your team's reference.
List of tags assigned to this agent for categorization and filtering.
Configuration for how the agent handles user interruptions during conversation.
Show child attributes
Show child attributes
Language model configuration for the agent.
Speech-to-text configuration for the agent.
Text-to-speech configuration for the agent.
Custom metadata associated with the agent.
Capture settings configuration for recording and artifact settings.
Show child attributes
Show child attributes
Volume settings for different call types and voice adjustment control.
Show child attributes
Show child attributes
Denoising/noise cancellation settings for enhanced audio quality powered by Krisp.
Show child attributes
Show child attributes
Date-time of when the agent was created (ISO 8601 on output).
Date-time of when the agent was last updated (ISO 8601 on output).
Was this page helpful?