Update an agent
Partially updates an agent: only fields present in the request body
are changed. twilio_config/telnyx_config merge onto the existing
provider config field-by-field (e.g. send just {"auth_token": "..."}
to rotate a credential without resending the phone number); send the
field as null to clear that provider’s config entirely. As with
create, telephony credentials are write-only and no live carrier
verification happens here.
curl --request PATCH \
--url https://app.eclatira.com/api/v1/agents/{agent_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"instruction": "<string>",
"first_message": "<string>",
"voice_id": "<string>",
"language": "<string>",
"language_code": "<string>",
"accent": "<string>",
"can_end_conversation": true,
"transfer_phone_number": "<string>",
"transfer_criteria": "<string>",
"variable_placeholders": {},
"voicemail_config": {
"enabled": false,
"message": "<string>",
"detection_timeout_seconds": 123,
"retry_on_voicemail": true
},
"twilio_config": {
"account_sid": "<string>",
"auth_token": "<string>",
"phone_number": "<string>"
},
"telnyx_config": {
"api_key": "<string>",
"phone_number": "<string>",
"connection_id": "<string>",
"account_sid": "<string>",
"public_key": "<string>"
},
"realtime": {
"enable_webcam": true,
"enable_screen_share": true
}
}
'import requests
url = "https://app.eclatira.com/api/v1/agents/{agent_id}"
payload = {
"name": "<string>",
"description": "<string>",
"instruction": "<string>",
"first_message": "<string>",
"voice_id": "<string>",
"language": "<string>",
"language_code": "<string>",
"accent": "<string>",
"can_end_conversation": True,
"transfer_phone_number": "<string>",
"transfer_criteria": "<string>",
"variable_placeholders": {},
"voicemail_config": {
"enabled": False,
"message": "<string>",
"detection_timeout_seconds": 123,
"retry_on_voicemail": True
},
"twilio_config": {
"account_sid": "<string>",
"auth_token": "<string>",
"phone_number": "<string>"
},
"telnyx_config": {
"api_key": "<string>",
"phone_number": "<string>",
"connection_id": "<string>",
"account_sid": "<string>",
"public_key": "<string>"
},
"realtime": {
"enable_webcam": True,
"enable_screen_share": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
instruction: '<string>',
first_message: '<string>',
voice_id: '<string>',
language: '<string>',
language_code: '<string>',
accent: '<string>',
can_end_conversation: true,
transfer_phone_number: '<string>',
transfer_criteria: '<string>',
variable_placeholders: {},
voicemail_config: {
enabled: false,
message: '<string>',
detection_timeout_seconds: 123,
retry_on_voicemail: true
},
twilio_config: {account_sid: '<string>', auth_token: '<string>', phone_number: '<string>'},
telnyx_config: {
api_key: '<string>',
phone_number: '<string>',
connection_id: '<string>',
account_sid: '<string>',
public_key: '<string>'
},
realtime: {enable_webcam: true, enable_screen_share: true}
})
};
fetch('https://app.eclatira.com/api/v1/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://app.eclatira.com/api/v1/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'instruction' => '<string>',
'first_message' => '<string>',
'voice_id' => '<string>',
'language' => '<string>',
'language_code' => '<string>',
'accent' => '<string>',
'can_end_conversation' => true,
'transfer_phone_number' => '<string>',
'transfer_criteria' => '<string>',
'variable_placeholders' => [
],
'voicemail_config' => [
'enabled' => false,
'message' => '<string>',
'detection_timeout_seconds' => 123,
'retry_on_voicemail' => true
],
'twilio_config' => [
'account_sid' => '<string>',
'auth_token' => '<string>',
'phone_number' => '<string>'
],
'telnyx_config' => [
'api_key' => '<string>',
'phone_number' => '<string>',
'connection_id' => '<string>',
'account_sid' => '<string>',
'public_key' => '<string>'
],
'realtime' => [
'enable_webcam' => true,
'enable_screen_share' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.eclatira.com/api/v1/agents/{agent_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instruction\": \"<string>\",\n \"first_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"language\": \"<string>\",\n \"language_code\": \"<string>\",\n \"accent\": \"<string>\",\n \"can_end_conversation\": true,\n \"transfer_phone_number\": \"<string>\",\n \"transfer_criteria\": \"<string>\",\n \"variable_placeholders\": {},\n \"voicemail_config\": {\n \"enabled\": false,\n \"message\": \"<string>\",\n \"detection_timeout_seconds\": 123,\n \"retry_on_voicemail\": true\n },\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\",\n \"phone_number\": \"<string>\"\n },\n \"telnyx_config\": {\n \"api_key\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"account_sid\": \"<string>\",\n \"public_key\": \"<string>\"\n },\n \"realtime\": {\n \"enable_webcam\": true,\n \"enable_screen_share\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.eclatira.com/api/v1/agents/{agent_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instruction\": \"<string>\",\n \"first_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"language\": \"<string>\",\n \"language_code\": \"<string>\",\n \"accent\": \"<string>\",\n \"can_end_conversation\": true,\n \"transfer_phone_number\": \"<string>\",\n \"transfer_criteria\": \"<string>\",\n \"variable_placeholders\": {},\n \"voicemail_config\": {\n \"enabled\": false,\n \"message\": \"<string>\",\n \"detection_timeout_seconds\": 123,\n \"retry_on_voicemail\": true\n },\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\",\n \"phone_number\": \"<string>\"\n },\n \"telnyx_config\": {\n \"api_key\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"account_sid\": \"<string>\",\n \"public_key\": \"<string>\"\n },\n \"realtime\": {\n \"enable_webcam\": true,\n \"enable_screen_share\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.eclatira.com/api/v1/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instruction\": \"<string>\",\n \"first_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"language\": \"<string>\",\n \"language_code\": \"<string>\",\n \"accent\": \"<string>\",\n \"can_end_conversation\": true,\n \"transfer_phone_number\": \"<string>\",\n \"transfer_criteria\": \"<string>\",\n \"variable_placeholders\": {},\n \"voicemail_config\": {\n \"enabled\": false,\n \"message\": \"<string>\",\n \"detection_timeout_seconds\": 123,\n \"retry_on_voicemail\": true\n },\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\",\n \"phone_number\": \"<string>\"\n },\n \"telnyx_config\": {\n \"api_key\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"account_sid\": \"<string>\",\n \"public_key\": \"<string>\"\n },\n \"realtime\": {\n \"enable_webcam\": true,\n \"enable_screen_share\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"name": "<string>",
"description": "<string>",
"instruction": "<string>",
"first_message": "<string>",
"telephony": {
"twilio": {
"configured": true,
"phone_number": "<string>",
"inbound_enabled": false
},
"telnyx": {
"configured": true,
"phone_number": "<string>",
"inbound_enabled": false
}
},
"realtime": {
"enable_webcam": true,
"enable_screen_share": true
},
"voice_id": "<string>",
"language": "<string>",
"language_code": "<string>",
"accent": "<string>",
"can_end_conversation": false,
"transfer_phone_number": "<string>",
"transfer_criteria": "<string>",
"variable_placeholders": {},
"voicemail_config": {
"enabled": false,
"message": "<string>",
"detection_timeout_seconds": 123,
"retry_on_voicemail": true
},
"created_at": "<string>"
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}Authorizations
A long-lived, privileged API key (ek_... prefix), minted once from the dashboard. Intended for trusted server-side use only; never expose it in client-side code. Send as Authorization: Bearer ek_.... Required by every Calls, Batches, Agents, Tools, MCP Servers, Documents, and Realtime route.
Path Parameters
Body
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Which realtime session sources this agent accepts.
Both default to enabled. They gate POST /api/v1/realtime/sessions for
source: "camera" and source: "screen", and the embed widget's own
controls, from the same stored setting — so turning one off here also
removes the corresponding button from the widget.
Show child attributes
Show child attributes
Response
Successful Response
Show child attributes
Show child attributes
The effective realtime capabilities of this agent.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
curl --request PATCH \
--url https://app.eclatira.com/api/v1/agents/{agent_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"instruction": "<string>",
"first_message": "<string>",
"voice_id": "<string>",
"language": "<string>",
"language_code": "<string>",
"accent": "<string>",
"can_end_conversation": true,
"transfer_phone_number": "<string>",
"transfer_criteria": "<string>",
"variable_placeholders": {},
"voicemail_config": {
"enabled": false,
"message": "<string>",
"detection_timeout_seconds": 123,
"retry_on_voicemail": true
},
"twilio_config": {
"account_sid": "<string>",
"auth_token": "<string>",
"phone_number": "<string>"
},
"telnyx_config": {
"api_key": "<string>",
"phone_number": "<string>",
"connection_id": "<string>",
"account_sid": "<string>",
"public_key": "<string>"
},
"realtime": {
"enable_webcam": true,
"enable_screen_share": true
}
}
'import requests
url = "https://app.eclatira.com/api/v1/agents/{agent_id}"
payload = {
"name": "<string>",
"description": "<string>",
"instruction": "<string>",
"first_message": "<string>",
"voice_id": "<string>",
"language": "<string>",
"language_code": "<string>",
"accent": "<string>",
"can_end_conversation": True,
"transfer_phone_number": "<string>",
"transfer_criteria": "<string>",
"variable_placeholders": {},
"voicemail_config": {
"enabled": False,
"message": "<string>",
"detection_timeout_seconds": 123,
"retry_on_voicemail": True
},
"twilio_config": {
"account_sid": "<string>",
"auth_token": "<string>",
"phone_number": "<string>"
},
"telnyx_config": {
"api_key": "<string>",
"phone_number": "<string>",
"connection_id": "<string>",
"account_sid": "<string>",
"public_key": "<string>"
},
"realtime": {
"enable_webcam": True,
"enable_screen_share": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
instruction: '<string>',
first_message: '<string>',
voice_id: '<string>',
language: '<string>',
language_code: '<string>',
accent: '<string>',
can_end_conversation: true,
transfer_phone_number: '<string>',
transfer_criteria: '<string>',
variable_placeholders: {},
voicemail_config: {
enabled: false,
message: '<string>',
detection_timeout_seconds: 123,
retry_on_voicemail: true
},
twilio_config: {account_sid: '<string>', auth_token: '<string>', phone_number: '<string>'},
telnyx_config: {
api_key: '<string>',
phone_number: '<string>',
connection_id: '<string>',
account_sid: '<string>',
public_key: '<string>'
},
realtime: {enable_webcam: true, enable_screen_share: true}
})
};
fetch('https://app.eclatira.com/api/v1/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://app.eclatira.com/api/v1/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'instruction' => '<string>',
'first_message' => '<string>',
'voice_id' => '<string>',
'language' => '<string>',
'language_code' => '<string>',
'accent' => '<string>',
'can_end_conversation' => true,
'transfer_phone_number' => '<string>',
'transfer_criteria' => '<string>',
'variable_placeholders' => [
],
'voicemail_config' => [
'enabled' => false,
'message' => '<string>',
'detection_timeout_seconds' => 123,
'retry_on_voicemail' => true
],
'twilio_config' => [
'account_sid' => '<string>',
'auth_token' => '<string>',
'phone_number' => '<string>'
],
'telnyx_config' => [
'api_key' => '<string>',
'phone_number' => '<string>',
'connection_id' => '<string>',
'account_sid' => '<string>',
'public_key' => '<string>'
],
'realtime' => [
'enable_webcam' => true,
'enable_screen_share' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.eclatira.com/api/v1/agents/{agent_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instruction\": \"<string>\",\n \"first_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"language\": \"<string>\",\n \"language_code\": \"<string>\",\n \"accent\": \"<string>\",\n \"can_end_conversation\": true,\n \"transfer_phone_number\": \"<string>\",\n \"transfer_criteria\": \"<string>\",\n \"variable_placeholders\": {},\n \"voicemail_config\": {\n \"enabled\": false,\n \"message\": \"<string>\",\n \"detection_timeout_seconds\": 123,\n \"retry_on_voicemail\": true\n },\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\",\n \"phone_number\": \"<string>\"\n },\n \"telnyx_config\": {\n \"api_key\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"account_sid\": \"<string>\",\n \"public_key\": \"<string>\"\n },\n \"realtime\": {\n \"enable_webcam\": true,\n \"enable_screen_share\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.eclatira.com/api/v1/agents/{agent_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instruction\": \"<string>\",\n \"first_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"language\": \"<string>\",\n \"language_code\": \"<string>\",\n \"accent\": \"<string>\",\n \"can_end_conversation\": true,\n \"transfer_phone_number\": \"<string>\",\n \"transfer_criteria\": \"<string>\",\n \"variable_placeholders\": {},\n \"voicemail_config\": {\n \"enabled\": false,\n \"message\": \"<string>\",\n \"detection_timeout_seconds\": 123,\n \"retry_on_voicemail\": true\n },\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\",\n \"phone_number\": \"<string>\"\n },\n \"telnyx_config\": {\n \"api_key\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"account_sid\": \"<string>\",\n \"public_key\": \"<string>\"\n },\n \"realtime\": {\n \"enable_webcam\": true,\n \"enable_screen_share\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.eclatira.com/api/v1/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instruction\": \"<string>\",\n \"first_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"language\": \"<string>\",\n \"language_code\": \"<string>\",\n \"accent\": \"<string>\",\n \"can_end_conversation\": true,\n \"transfer_phone_number\": \"<string>\",\n \"transfer_criteria\": \"<string>\",\n \"variable_placeholders\": {},\n \"voicemail_config\": {\n \"enabled\": false,\n \"message\": \"<string>\",\n \"detection_timeout_seconds\": 123,\n \"retry_on_voicemail\": true\n },\n \"twilio_config\": {\n \"account_sid\": \"<string>\",\n \"auth_token\": \"<string>\",\n \"phone_number\": \"<string>\"\n },\n \"telnyx_config\": {\n \"api_key\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"account_sid\": \"<string>\",\n \"public_key\": \"<string>\"\n },\n \"realtime\": {\n \"enable_webcam\": true,\n \"enable_screen_share\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"name": "<string>",
"description": "<string>",
"instruction": "<string>",
"first_message": "<string>",
"telephony": {
"twilio": {
"configured": true,
"phone_number": "<string>",
"inbound_enabled": false
},
"telnyx": {
"configured": true,
"phone_number": "<string>",
"inbound_enabled": false
}
},
"realtime": {
"enable_webcam": true,
"enable_screen_share": true
},
"voice_id": "<string>",
"language": "<string>",
"language_code": "<string>",
"accent": "<string>",
"can_end_conversation": false,
"transfer_phone_number": "<string>",
"transfer_criteria": "<string>",
"variable_placeholders": {},
"voicemail_config": {
"enabled": false,
"message": "<string>",
"detection_timeout_seconds": 123,
"retry_on_voicemail": true
},
"created_at": "<string>"
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>"
}
}