curl --request PATCH \
--url https://api.example.com/v2/call-agent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"end_call_on_recording_refusal": true,
"recording_disclaimer_required": true,
"outbound_begin_message": "<string>",
"voice_id": "<string>",
"voice_temperature": 1,
"language_code": "<string>",
"custom_prompt": "<string>"
}
'import requests
url = "https://api.example.com/v2/call-agent"
payload = {
"end_call_on_recording_refusal": True,
"recording_disclaimer_required": True,
"outbound_begin_message": "<string>",
"voice_id": "<string>",
"voice_temperature": 1,
"language_code": "<string>",
"custom_prompt": "<string>"
}
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({
end_call_on_recording_refusal: true,
recording_disclaimer_required: true,
outbound_begin_message: '<string>',
voice_id: '<string>',
voice_temperature: 1,
language_code: '<string>',
custom_prompt: '<string>'
})
};
fetch('https://api.example.com/v2/call-agent', 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/v2/call-agent",
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([
'end_call_on_recording_refusal' => true,
'recording_disclaimer_required' => true,
'outbound_begin_message' => '<string>',
'voice_id' => '<string>',
'voice_temperature' => 1,
'language_code' => '<string>',
'custom_prompt' => '<string>'
]),
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://api.example.com/v2/call-agent"
payload := strings.NewReader("{\n \"end_call_on_recording_refusal\": true,\n \"recording_disclaimer_required\": true,\n \"outbound_begin_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_temperature\": 1,\n \"language_code\": \"<string>\",\n \"custom_prompt\": \"<string>\"\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://api.example.com/v2/call-agent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"end_call_on_recording_refusal\": true,\n \"recording_disclaimer_required\": true,\n \"outbound_begin_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_temperature\": 1,\n \"language_code\": \"<string>\",\n \"custom_prompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/call-agent")
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 \"end_call_on_recording_refusal\": true,\n \"recording_disclaimer_required\": true,\n \"outbound_begin_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_temperature\": 1,\n \"language_code\": \"<string>\",\n \"custom_prompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"end_call_on_recording_refusal": true,
"recording_disclaimer_required": true,
"outbound_begin_message": "<string>",
"voice_id": "<string>",
"voice": {
"id": "<string>",
"name": "<string>",
"accent": "<string>",
"age": "<string>",
"gender": "<string>",
"provider": "<string>",
"preview_audio_url": "<string>"
},
"voice_speed": "slowest",
"voice_temperature": 123,
"stt_mode": "auto",
"language_code": "<string>",
"custom_prompt": "<string>"
}{
"type": "request-validation",
"status": 422,
"title": "<string>",
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
],
"detail": "<string>"
}Update Call Agent
Update Call Agent
Update voice and personality settings for the organization’s call agent.
curl --request PATCH \
--url https://api.example.com/v2/call-agent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"end_call_on_recording_refusal": true,
"recording_disclaimer_required": true,
"outbound_begin_message": "<string>",
"voice_id": "<string>",
"voice_temperature": 1,
"language_code": "<string>",
"custom_prompt": "<string>"
}
'import requests
url = "https://api.example.com/v2/call-agent"
payload = {
"end_call_on_recording_refusal": True,
"recording_disclaimer_required": True,
"outbound_begin_message": "<string>",
"voice_id": "<string>",
"voice_temperature": 1,
"language_code": "<string>",
"custom_prompt": "<string>"
}
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({
end_call_on_recording_refusal: true,
recording_disclaimer_required: true,
outbound_begin_message: '<string>',
voice_id: '<string>',
voice_temperature: 1,
language_code: '<string>',
custom_prompt: '<string>'
})
};
fetch('https://api.example.com/v2/call-agent', 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/v2/call-agent",
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([
'end_call_on_recording_refusal' => true,
'recording_disclaimer_required' => true,
'outbound_begin_message' => '<string>',
'voice_id' => '<string>',
'voice_temperature' => 1,
'language_code' => '<string>',
'custom_prompt' => '<string>'
]),
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://api.example.com/v2/call-agent"
payload := strings.NewReader("{\n \"end_call_on_recording_refusal\": true,\n \"recording_disclaimer_required\": true,\n \"outbound_begin_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_temperature\": 1,\n \"language_code\": \"<string>\",\n \"custom_prompt\": \"<string>\"\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://api.example.com/v2/call-agent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"end_call_on_recording_refusal\": true,\n \"recording_disclaimer_required\": true,\n \"outbound_begin_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_temperature\": 1,\n \"language_code\": \"<string>\",\n \"custom_prompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/call-agent")
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 \"end_call_on_recording_refusal\": true,\n \"recording_disclaimer_required\": true,\n \"outbound_begin_message\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"voice_temperature\": 1,\n \"language_code\": \"<string>\",\n \"custom_prompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"end_call_on_recording_refusal": true,
"recording_disclaimer_required": true,
"outbound_begin_message": "<string>",
"voice_id": "<string>",
"voice": {
"id": "<string>",
"name": "<string>",
"accent": "<string>",
"age": "<string>",
"gender": "<string>",
"provider": "<string>",
"preview_audio_url": "<string>"
},
"voice_speed": "slowest",
"voice_temperature": 123,
"stt_mode": "auto",
"language_code": "<string>",
"custom_prompt": "<string>"
}{
"type": "request-validation",
"status": 422,
"title": "<string>",
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
],
"detail": "<string>"
}Authorizations
Body
Update call agent voice and personality settings.
STT model selection mode for voice agents.
AUTO: Multilingual Scribe (never pinned) + LanguageObserver hot-swaps STT to the
detected language; a configured language_code is only a detection hint.
FLUX: Legacy — equivalent to OFF + English (Deepgram Flux, built-in turn detection).
Hidden from the dropdown; kept for existing rows. No observer; ignores language_code.
OFF: Hard pin to language_code (required) — Flux when English, else pinned Scribe. No observer.
SCRIBE: Legacy multilingual Scribe, no observer. Hidden from the UI; kept for existing rows.
auto, flux, off, scribe Response
Successful Response
Call agent with current voice details.
STT model selection mode for voice agents.
AUTO: Multilingual Scribe (never pinned) + LanguageObserver hot-swaps STT to the
detected language; a configured language_code is only a detection hint.
FLUX: Legacy — equivalent to OFF + English (Deepgram Flux, built-in turn detection).
Hidden from the dropdown; kept for existing rows. No observer; ignores language_code.
OFF: Hard pin to language_code (required) — Flux when English, else pinned Scribe. No observer.
SCRIBE: Legacy multilingual Scribe, no observer. Hidden from the UI; kept for existing rows.
auto, flux, off, scribe 