Update an agent
curl --request PATCH \
--url https://api.cartesia.ai/v1/agents/{agent_id} \
--header 'Authorization: Bearer <token>' \
--header 'Cartesia-Version: <cartesia-version>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"audio": {
"input": {
"keyterms": [
"<string>"
]
},
"output": {
"background_sound": {
"file_id": "<string>",
"volume": 1
},
"emotion": "<string>",
"pronunciation_dictionary_id": "<string>",
"speed": 1.05,
"voice_id": "<string>",
"volume": 1.25
}
},
"initial_message": "<string>",
"instructions": "<string>",
"language": {
"primary": "<string>"
},
"model": {
"id": "<string>",
"max_output_tokens": 2048,
"temperature": 0.5
},
"system_tools": {
"end_call": {
"description": "<string>"
},
"send_dtmf": {
"description": "<string>"
},
"transfer_to_number": {
"description": "<string>",
"transfers": [
{
"condition": "<string>",
"destination": {
"phone_number": "<string>",
"type": "phone"
}
}
]
}
},
"tools": [
{
"id": "<string>"
}
]
},
"description": "<string>",
"name": "<string>",
"version_description": "<string>"
}
'import requests
url = "https://api.cartesia.ai/v1/agents/{agent_id}"
payload = {
"config": {
"audio": {
"input": { "keyterms": ["<string>"] },
"output": {
"background_sound": {
"file_id": "<string>",
"volume": 1
},
"emotion": "<string>",
"pronunciation_dictionary_id": "<string>",
"speed": 1.05,
"voice_id": "<string>",
"volume": 1.25
}
},
"initial_message": "<string>",
"instructions": "<string>",
"language": { "primary": "<string>" },
"model": {
"id": "<string>",
"max_output_tokens": 2048,
"temperature": 0.5
},
"system_tools": {
"end_call": { "description": "<string>" },
"send_dtmf": { "description": "<string>" },
"transfer_to_number": {
"description": "<string>",
"transfers": [
{
"condition": "<string>",
"destination": {
"phone_number": "<string>",
"type": "phone"
}
}
]
}
},
"tools": [{ "id": "<string>" }]
},
"description": "<string>",
"name": "<string>",
"version_description": "<string>"
}
headers = {
"Cartesia-Version": "<cartesia-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Cartesia-Version': '<cartesia-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
config: {
audio: {
input: {keyterms: ['<string>']},
output: {
background_sound: {file_id: '<string>', volume: 1},
emotion: '<string>',
pronunciation_dictionary_id: '<string>',
speed: 1.05,
voice_id: '<string>',
volume: 1.25
}
},
initial_message: '<string>',
instructions: '<string>',
language: {primary: '<string>'},
model: {id: '<string>', max_output_tokens: 2048, temperature: 0.5},
system_tools: {
end_call: {description: '<string>'},
send_dtmf: {description: '<string>'},
transfer_to_number: {
description: '<string>',
transfers: [
{condition: '<string>', destination: {phone_number: '<string>', type: 'phone'}}
]
}
},
tools: [{id: '<string>'}]
},
description: '<string>',
name: '<string>',
version_description: '<string>'
})
};
fetch('https://api.cartesia.ai/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://api.cartesia.ai/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([
'config' => [
'audio' => [
'input' => [
'keyterms' => [
'<string>'
]
],
'output' => [
'background_sound' => [
'file_id' => '<string>',
'volume' => 1
],
'emotion' => '<string>',
'pronunciation_dictionary_id' => '<string>',
'speed' => 1.05,
'voice_id' => '<string>',
'volume' => 1.25
]
],
'initial_message' => '<string>',
'instructions' => '<string>',
'language' => [
'primary' => '<string>'
],
'model' => [
'id' => '<string>',
'max_output_tokens' => 2048,
'temperature' => 0.5
],
'system_tools' => [
'end_call' => [
'description' => '<string>'
],
'send_dtmf' => [
'description' => '<string>'
],
'transfer_to_number' => [
'description' => '<string>',
'transfers' => [
[
'condition' => '<string>',
'destination' => [
'phone_number' => '<string>',
'type' => 'phone'
]
]
]
]
],
'tools' => [
[
'id' => '<string>'
]
]
],
'description' => '<string>',
'name' => '<string>',
'version_description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Cartesia-Version: <cartesia-version>",
"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://api.cartesia.ai/v1/agents/{agent_id}"
payload := strings.NewReader("{\n \"config\": {\n \"audio\": {\n \"input\": {\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"output\": {\n \"background_sound\": {\n \"file_id\": \"<string>\",\n \"volume\": 1\n },\n \"emotion\": \"<string>\",\n \"pronunciation_dictionary_id\": \"<string>\",\n \"speed\": 1.05,\n \"voice_id\": \"<string>\",\n \"volume\": 1.25\n }\n },\n \"initial_message\": \"<string>\",\n \"instructions\": \"<string>\",\n \"language\": {\n \"primary\": \"<string>\"\n },\n \"model\": {\n \"id\": \"<string>\",\n \"max_output_tokens\": 2048,\n \"temperature\": 0.5\n },\n \"system_tools\": {\n \"end_call\": {\n \"description\": \"<string>\"\n },\n \"send_dtmf\": {\n \"description\": \"<string>\"\n },\n \"transfer_to_number\": {\n \"description\": \"<string>\",\n \"transfers\": [\n {\n \"condition\": \"<string>\",\n \"destination\": {\n \"phone_number\": \"<string>\",\n \"type\": \"phone\"\n }\n }\n ]\n }\n },\n \"tools\": [\n {\n \"id\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"version_description\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Cartesia-Version", "<cartesia-version>")
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://api.cartesia.ai/v1/agents/{agent_id}")
.header("Cartesia-Version", "<cartesia-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"audio\": {\n \"input\": {\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"output\": {\n \"background_sound\": {\n \"file_id\": \"<string>\",\n \"volume\": 1\n },\n \"emotion\": \"<string>\",\n \"pronunciation_dictionary_id\": \"<string>\",\n \"speed\": 1.05,\n \"voice_id\": \"<string>\",\n \"volume\": 1.25\n }\n },\n \"initial_message\": \"<string>\",\n \"instructions\": \"<string>\",\n \"language\": {\n \"primary\": \"<string>\"\n },\n \"model\": {\n \"id\": \"<string>\",\n \"max_output_tokens\": 2048,\n \"temperature\": 0.5\n },\n \"system_tools\": {\n \"end_call\": {\n \"description\": \"<string>\"\n },\n \"send_dtmf\": {\n \"description\": \"<string>\"\n },\n \"transfer_to_number\": {\n \"description\": \"<string>\",\n \"transfers\": [\n {\n \"condition\": \"<string>\",\n \"destination\": {\n \"phone_number\": \"<string>\",\n \"type\": \"phone\"\n }\n }\n ]\n }\n },\n \"tools\": [\n {\n \"id\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"version_description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cartesia.ai/v1/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Cartesia-Version"] = '<cartesia-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"audio\": {\n \"input\": {\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"output\": {\n \"background_sound\": {\n \"file_id\": \"<string>\",\n \"volume\": 1\n },\n \"emotion\": \"<string>\",\n \"pronunciation_dictionary_id\": \"<string>\",\n \"speed\": 1.05,\n \"voice_id\": \"<string>\",\n \"volume\": 1.25\n }\n },\n \"initial_message\": \"<string>\",\n \"instructions\": \"<string>\",\n \"language\": {\n \"primary\": \"<string>\"\n },\n \"model\": {\n \"id\": \"<string>\",\n \"max_output_tokens\": 2048,\n \"temperature\": 0.5\n },\n \"system_tools\": {\n \"end_call\": {\n \"description\": \"<string>\"\n },\n \"send_dtmf\": {\n \"description\": \"<string>\"\n },\n \"transfer_to_number\": {\n \"description\": \"<string>\",\n \"transfers\": [\n {\n \"condition\": \"<string>\",\n \"destination\": {\n \"phone_number\": \"<string>\",\n \"type\": \"phone\"\n }\n }\n ]\n }\n },\n \"tools\": [\n {\n \"id\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"version_description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"audio": {
"input": {
"keyterms": [
"<string>"
],
"noise_suppression": "off"
},
"output": {
"background_sound": {
"file_id": "<string>",
"volume": 1
},
"emotion": "<string>",
"pronunciation_dictionary_id": "<string>",
"speed": 1.05,
"voice_id": "<string>",
"volume": 1.25
}
},
"initial_message": "<string>",
"instructions": "<string>",
"language": {
"primary": "<string>"
},
"model": {
"id": "gpt-5.4-mini",
"max_output_tokens": 2048,
"temperature": 0.5
},
"system_tools": {
"end_call": {
"description": "<string>",
"pre_tool_speech": "auto"
},
"send_dtmf": {
"description": "<string>",
"pre_tool_speech": "auto"
},
"transfer_to_number": {
"description": "<string>",
"pre_tool_speech": "auto",
"transfers": [
{
"condition": "<string>",
"destination": {
"phone_number": "<string>",
"type": "phone"
}
}
]
}
},
"tools": [
{
"id": "<string>"
}
]
},
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"description": "<string>",
"id": "<string>"
}
}{
"message": "<string>",
"request_id": "<string>",
"title": "<string>",
"doc_url": "<string>",
"error_code": "<string>"
}Agents
Update Agent
Sparsely updates agent metadata or configuration. Configuration changes create a new immutable version.
PATCH
/
v1
/
agents
/
{agent_id}
Update an agent
curl --request PATCH \
--url https://api.cartesia.ai/v1/agents/{agent_id} \
--header 'Authorization: Bearer <token>' \
--header 'Cartesia-Version: <cartesia-version>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"audio": {
"input": {
"keyterms": [
"<string>"
]
},
"output": {
"background_sound": {
"file_id": "<string>",
"volume": 1
},
"emotion": "<string>",
"pronunciation_dictionary_id": "<string>",
"speed": 1.05,
"voice_id": "<string>",
"volume": 1.25
}
},
"initial_message": "<string>",
"instructions": "<string>",
"language": {
"primary": "<string>"
},
"model": {
"id": "<string>",
"max_output_tokens": 2048,
"temperature": 0.5
},
"system_tools": {
"end_call": {
"description": "<string>"
},
"send_dtmf": {
"description": "<string>"
},
"transfer_to_number": {
"description": "<string>",
"transfers": [
{
"condition": "<string>",
"destination": {
"phone_number": "<string>",
"type": "phone"
}
}
]
}
},
"tools": [
{
"id": "<string>"
}
]
},
"description": "<string>",
"name": "<string>",
"version_description": "<string>"
}
'import requests
url = "https://api.cartesia.ai/v1/agents/{agent_id}"
payload = {
"config": {
"audio": {
"input": { "keyterms": ["<string>"] },
"output": {
"background_sound": {
"file_id": "<string>",
"volume": 1
},
"emotion": "<string>",
"pronunciation_dictionary_id": "<string>",
"speed": 1.05,
"voice_id": "<string>",
"volume": 1.25
}
},
"initial_message": "<string>",
"instructions": "<string>",
"language": { "primary": "<string>" },
"model": {
"id": "<string>",
"max_output_tokens": 2048,
"temperature": 0.5
},
"system_tools": {
"end_call": { "description": "<string>" },
"send_dtmf": { "description": "<string>" },
"transfer_to_number": {
"description": "<string>",
"transfers": [
{
"condition": "<string>",
"destination": {
"phone_number": "<string>",
"type": "phone"
}
}
]
}
},
"tools": [{ "id": "<string>" }]
},
"description": "<string>",
"name": "<string>",
"version_description": "<string>"
}
headers = {
"Cartesia-Version": "<cartesia-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Cartesia-Version': '<cartesia-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
config: {
audio: {
input: {keyterms: ['<string>']},
output: {
background_sound: {file_id: '<string>', volume: 1},
emotion: '<string>',
pronunciation_dictionary_id: '<string>',
speed: 1.05,
voice_id: '<string>',
volume: 1.25
}
},
initial_message: '<string>',
instructions: '<string>',
language: {primary: '<string>'},
model: {id: '<string>', max_output_tokens: 2048, temperature: 0.5},
system_tools: {
end_call: {description: '<string>'},
send_dtmf: {description: '<string>'},
transfer_to_number: {
description: '<string>',
transfers: [
{condition: '<string>', destination: {phone_number: '<string>', type: 'phone'}}
]
}
},
tools: [{id: '<string>'}]
},
description: '<string>',
name: '<string>',
version_description: '<string>'
})
};
fetch('https://api.cartesia.ai/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://api.cartesia.ai/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([
'config' => [
'audio' => [
'input' => [
'keyterms' => [
'<string>'
]
],
'output' => [
'background_sound' => [
'file_id' => '<string>',
'volume' => 1
],
'emotion' => '<string>',
'pronunciation_dictionary_id' => '<string>',
'speed' => 1.05,
'voice_id' => '<string>',
'volume' => 1.25
]
],
'initial_message' => '<string>',
'instructions' => '<string>',
'language' => [
'primary' => '<string>'
],
'model' => [
'id' => '<string>',
'max_output_tokens' => 2048,
'temperature' => 0.5
],
'system_tools' => [
'end_call' => [
'description' => '<string>'
],
'send_dtmf' => [
'description' => '<string>'
],
'transfer_to_number' => [
'description' => '<string>',
'transfers' => [
[
'condition' => '<string>',
'destination' => [
'phone_number' => '<string>',
'type' => 'phone'
]
]
]
]
],
'tools' => [
[
'id' => '<string>'
]
]
],
'description' => '<string>',
'name' => '<string>',
'version_description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Cartesia-Version: <cartesia-version>",
"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://api.cartesia.ai/v1/agents/{agent_id}"
payload := strings.NewReader("{\n \"config\": {\n \"audio\": {\n \"input\": {\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"output\": {\n \"background_sound\": {\n \"file_id\": \"<string>\",\n \"volume\": 1\n },\n \"emotion\": \"<string>\",\n \"pronunciation_dictionary_id\": \"<string>\",\n \"speed\": 1.05,\n \"voice_id\": \"<string>\",\n \"volume\": 1.25\n }\n },\n \"initial_message\": \"<string>\",\n \"instructions\": \"<string>\",\n \"language\": {\n \"primary\": \"<string>\"\n },\n \"model\": {\n \"id\": \"<string>\",\n \"max_output_tokens\": 2048,\n \"temperature\": 0.5\n },\n \"system_tools\": {\n \"end_call\": {\n \"description\": \"<string>\"\n },\n \"send_dtmf\": {\n \"description\": \"<string>\"\n },\n \"transfer_to_number\": {\n \"description\": \"<string>\",\n \"transfers\": [\n {\n \"condition\": \"<string>\",\n \"destination\": {\n \"phone_number\": \"<string>\",\n \"type\": \"phone\"\n }\n }\n ]\n }\n },\n \"tools\": [\n {\n \"id\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"version_description\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Cartesia-Version", "<cartesia-version>")
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://api.cartesia.ai/v1/agents/{agent_id}")
.header("Cartesia-Version", "<cartesia-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"audio\": {\n \"input\": {\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"output\": {\n \"background_sound\": {\n \"file_id\": \"<string>\",\n \"volume\": 1\n },\n \"emotion\": \"<string>\",\n \"pronunciation_dictionary_id\": \"<string>\",\n \"speed\": 1.05,\n \"voice_id\": \"<string>\",\n \"volume\": 1.25\n }\n },\n \"initial_message\": \"<string>\",\n \"instructions\": \"<string>\",\n \"language\": {\n \"primary\": \"<string>\"\n },\n \"model\": {\n \"id\": \"<string>\",\n \"max_output_tokens\": 2048,\n \"temperature\": 0.5\n },\n \"system_tools\": {\n \"end_call\": {\n \"description\": \"<string>\"\n },\n \"send_dtmf\": {\n \"description\": \"<string>\"\n },\n \"transfer_to_number\": {\n \"description\": \"<string>\",\n \"transfers\": [\n {\n \"condition\": \"<string>\",\n \"destination\": {\n \"phone_number\": \"<string>\",\n \"type\": \"phone\"\n }\n }\n ]\n }\n },\n \"tools\": [\n {\n \"id\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"version_description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cartesia.ai/v1/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Cartesia-Version"] = '<cartesia-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"audio\": {\n \"input\": {\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"output\": {\n \"background_sound\": {\n \"file_id\": \"<string>\",\n \"volume\": 1\n },\n \"emotion\": \"<string>\",\n \"pronunciation_dictionary_id\": \"<string>\",\n \"speed\": 1.05,\n \"voice_id\": \"<string>\",\n \"volume\": 1.25\n }\n },\n \"initial_message\": \"<string>\",\n \"instructions\": \"<string>\",\n \"language\": {\n \"primary\": \"<string>\"\n },\n \"model\": {\n \"id\": \"<string>\",\n \"max_output_tokens\": 2048,\n \"temperature\": 0.5\n },\n \"system_tools\": {\n \"end_call\": {\n \"description\": \"<string>\"\n },\n \"send_dtmf\": {\n \"description\": \"<string>\"\n },\n \"transfer_to_number\": {\n \"description\": \"<string>\",\n \"transfers\": [\n {\n \"condition\": \"<string>\",\n \"destination\": {\n \"phone_number\": \"<string>\",\n \"type\": \"phone\"\n }\n }\n ]\n }\n },\n \"tools\": [\n {\n \"id\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"version_description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"audio": {
"input": {
"keyterms": [
"<string>"
],
"noise_suppression": "off"
},
"output": {
"background_sound": {
"file_id": "<string>",
"volume": 1
},
"emotion": "<string>",
"pronunciation_dictionary_id": "<string>",
"speed": 1.05,
"voice_id": "<string>",
"volume": 1.25
}
},
"initial_message": "<string>",
"instructions": "<string>",
"language": {
"primary": "<string>"
},
"model": {
"id": "gpt-5.4-mini",
"max_output_tokens": 2048,
"temperature": 0.5
},
"system_tools": {
"end_call": {
"description": "<string>",
"pre_tool_speech": "auto"
},
"send_dtmf": {
"description": "<string>",
"pre_tool_speech": "auto"
},
"transfer_to_number": {
"description": "<string>",
"pre_tool_speech": "auto",
"transfers": [
{
"condition": "<string>",
"destination": {
"phone_number": "<string>",
"type": "phone"
}
}
]
}
},
"tools": [
{
"id": "<string>"
}
]
},
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"description": "<string>",
"id": "<string>"
}
}{
"message": "<string>",
"request_id": "<string>",
"title": "<string>",
"doc_url": "<string>",
"error_code": "<string>"
}Authorizations
Cartesia API key (sk_car_...). Get one at play.cartesia.ai/keys.
Headers
API version header.
Available options:
2026-08-14 Example:
"2026-08-14"
Path Parameters
Unique identifier for the agent.
Minimum string length:
1Body
application/json
Show child attributes
Show child attributes
Description of the agent.
Name shown for the agent. It does not need to be unique.
Required string length:
1 - 64Description to attach to the new configuration version. Allowed only when this request changes config.
Response
Update an agent
Complete configuration for the agent's model, language, audio, and tools.
Show child attributes
Show child attributes
An RFC 3339 / ISO 8601 date-time string with timezone (e.g. 2025-04-16T12:34:56.789Z).
Description of the agent.
Unique identifier for the agent.
Minimum string length:
1Name shown for the agent.
An RFC 3339 / ISO 8601 date-time string with timezone (e.g. 2025-04-16T12:34:56.789Z).
Show child attributes
Show child attributes
Was this page helpful?