Update Draft Config
curl --request PATCH \
--url https://api.fish.audio/v1/agent/agents/<agent-id>/config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"prompt": {
"system_prompt": "You are the receptionist for Fish Dental."
},
"webhooks": {
"post_call": [
{
"url": "https://example.com/hooks/fish",
"secret": "<signing-secret>"
}
]
}
}'import requests
url = "https://api.fish.audio/v1/agent/agents/{agent_id}/config"
payload = {
"prompt": {
"system_prompt": "<string>",
"first_message": "<string>",
"first_message_prompt": "<string>"
},
"voice": {
"voice_id": "<string>",
"expressive": True,
"speed": 1.25
},
"asr": {
"multilingual": True,
"strict_language": True,
"keyterms": ["<string>"]
},
"conversation": {
"max_duration_seconds": 1830,
"response_wait_ms": 1150,
"response_max_wait_ms": 2000,
"interruptible": True,
"interruption_ignore_phrases": ["<string>"],
"speculative_response": True,
"reengage_enabled": True,
"hangup_after_seconds": 1805,
"hangup_farewell_enabled": True,
"record_audio": True,
"timezone": "<string>",
"transfer_destinations": [
{
"type": "phone",
"label": "",
"phone_number": "<string>",
"sip_uri": "<string>",
"description": "",
"mode": "cold",
"warm_connect": "confirm",
"warm_briefing_instructions": "",
"on_failure": {
"action": "return_to_agent",
"message": ""
}
}
],
"outbound": {
"amd_enabled": True,
"voicemail": {
"action": "hangup",
"message": ""
}
}
},
"tools": {
"enabled": True,
"tool_ids": ["<string>"],
"system_tools": { "hang_up_call": True }
},
"webhooks": {
"conversation_init": {
"url": "<string>",
"secret": "<string>",
"timeout_seconds": 5
},
"post_call": [
{
"url": "<string>",
"secret": "<string>"
}
]
},
"knowledge_base": {
"enabled": True,
"knowledge_source_ids": ["<string>"]
},
"analysis": {
"summary": {
"enabled": True,
"prompt": "<string>",
"language": "en"
},
"data_fields": [
{
"name": "<string>",
"type": "text",
"description": "",
"enum_options": ["<string>"]
}
],
"criteria": [
{
"name": "<string>",
"description": ""
}
]
},
"guardrails": {
"focus": True,
"manipulation": True
},
"llm": { "custom": {
"base_url": "<string>",
"model": "<string>",
"api_key": "<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({
prompt: {
system_prompt: '<string>',
first_message: '<string>',
first_message_prompt: '<string>'
},
voice: {voice_id: '<string>', expressive: true, speed: 1.25},
asr: {multilingual: true, strict_language: true, keyterms: ['<string>']},
conversation: {
max_duration_seconds: 1830,
response_wait_ms: 1150,
response_max_wait_ms: 2000,
interruptible: true,
interruption_ignore_phrases: ['<string>'],
speculative_response: true,
reengage_enabled: true,
hangup_after_seconds: 1805,
hangup_farewell_enabled: true,
record_audio: true,
timezone: '<string>',
transfer_destinations: [
{
type: 'phone',
label: '',
phone_number: '<string>',
sip_uri: '<string>',
description: '',
mode: 'cold',
warm_connect: 'confirm',
warm_briefing_instructions: '',
on_failure: {action: 'return_to_agent', message: ''}
}
],
outbound: {amd_enabled: true, voicemail: {action: 'hangup', message: ''}}
},
tools: {enabled: true, tool_ids: ['<string>'], system_tools: {hang_up_call: true}},
webhooks: {
conversation_init: {url: '<string>', secret: '<string>', timeout_seconds: 5},
post_call: [{url: '<string>', secret: '<string>'}]
},
knowledge_base: {enabled: true, knowledge_source_ids: ['<string>']},
analysis: {
summary: {enabled: true, prompt: '<string>', language: 'en'},
data_fields: [{name: '<string>', type: 'text', description: '', enum_options: ['<string>']}],
criteria: [{name: '<string>', description: ''}]
},
guardrails: {focus: true, manipulation: true},
llm: {custom: {base_url: '<string>', model: '<string>', api_key: '<string>'}}
})
};
fetch('https://api.fish.audio/v1/agent/agents/{agent_id}/config', 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.fish.audio/v1/agent/agents/{agent_id}/config",
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([
'prompt' => [
'system_prompt' => '<string>',
'first_message' => '<string>',
'first_message_prompt' => '<string>'
],
'voice' => [
'voice_id' => '<string>',
'expressive' => true,
'speed' => 1.25
],
'asr' => [
'multilingual' => true,
'strict_language' => true,
'keyterms' => [
'<string>'
]
],
'conversation' => [
'max_duration_seconds' => 1830,
'response_wait_ms' => 1150,
'response_max_wait_ms' => 2000,
'interruptible' => true,
'interruption_ignore_phrases' => [
'<string>'
],
'speculative_response' => true,
'reengage_enabled' => true,
'hangup_after_seconds' => 1805,
'hangup_farewell_enabled' => true,
'record_audio' => true,
'timezone' => '<string>',
'transfer_destinations' => [
[
'type' => 'phone',
'label' => '',
'phone_number' => '<string>',
'sip_uri' => '<string>',
'description' => '',
'mode' => 'cold',
'warm_connect' => 'confirm',
'warm_briefing_instructions' => '',
'on_failure' => [
'action' => 'return_to_agent',
'message' => ''
]
]
],
'outbound' => [
'amd_enabled' => true,
'voicemail' => [
'action' => 'hangup',
'message' => ''
]
]
],
'tools' => [
'enabled' => true,
'tool_ids' => [
'<string>'
],
'system_tools' => [
'hang_up_call' => true
]
],
'webhooks' => [
'conversation_init' => [
'url' => '<string>',
'secret' => '<string>',
'timeout_seconds' => 5
],
'post_call' => [
[
'url' => '<string>',
'secret' => '<string>'
]
]
],
'knowledge_base' => [
'enabled' => true,
'knowledge_source_ids' => [
'<string>'
]
],
'analysis' => [
'summary' => [
'enabled' => true,
'prompt' => '<string>',
'language' => 'en'
],
'data_fields' => [
[
'name' => '<string>',
'type' => 'text',
'description' => '',
'enum_options' => [
'<string>'
]
]
],
'criteria' => [
[
'name' => '<string>',
'description' => ''
]
]
],
'guardrails' => [
'focus' => true,
'manipulation' => true
],
'llm' => [
'custom' => [
'base_url' => '<string>',
'model' => '<string>',
'api_key' => '<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.fish.audio/v1/agent/agents/{agent_id}/config"
payload := strings.NewReader("{\n \"prompt\": {\n \"system_prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\"\n },\n \"voice\": {\n \"voice_id\": \"<string>\",\n \"expressive\": true,\n \"speed\": 1.25\n },\n \"asr\": {\n \"multilingual\": true,\n \"strict_language\": true,\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"conversation\": {\n \"max_duration_seconds\": 1830,\n \"response_wait_ms\": 1150,\n \"response_max_wait_ms\": 2000,\n \"interruptible\": true,\n \"interruption_ignore_phrases\": [\n \"<string>\"\n ],\n \"speculative_response\": true,\n \"reengage_enabled\": true,\n \"hangup_after_seconds\": 1805,\n \"hangup_farewell_enabled\": true,\n \"record_audio\": true,\n \"timezone\": \"<string>\",\n \"transfer_destinations\": [\n {\n \"type\": \"phone\",\n \"label\": \"\",\n \"phone_number\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"description\": \"\",\n \"mode\": \"cold\",\n \"warm_connect\": \"confirm\",\n \"warm_briefing_instructions\": \"\",\n \"on_failure\": {\n \"action\": \"return_to_agent\",\n \"message\": \"\"\n }\n }\n ],\n \"outbound\": {\n \"amd_enabled\": true,\n \"voicemail\": {\n \"action\": \"hangup\",\n \"message\": \"\"\n }\n }\n },\n \"tools\": {\n \"enabled\": true,\n \"tool_ids\": [\n \"<string>\"\n ],\n \"system_tools\": {\n \"hang_up_call\": true\n }\n },\n \"webhooks\": {\n \"conversation_init\": {\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"timeout_seconds\": 5\n },\n \"post_call\": [\n {\n \"url\": \"<string>\",\n \"secret\": \"<string>\"\n }\n ]\n },\n \"knowledge_base\": {\n \"enabled\": true,\n \"knowledge_source_ids\": [\n \"<string>\"\n ]\n },\n \"analysis\": {\n \"summary\": {\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"language\": \"en\"\n },\n \"data_fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"text\",\n \"description\": \"\",\n \"enum_options\": [\n \"<string>\"\n ]\n }\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"\"\n }\n ]\n },\n \"guardrails\": {\n \"focus\": true,\n \"manipulation\": true\n },\n \"llm\": {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\"\n }\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://api.fish.audio/v1/agent/agents/{agent_id}/config")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": {\n \"system_prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\"\n },\n \"voice\": {\n \"voice_id\": \"<string>\",\n \"expressive\": true,\n \"speed\": 1.25\n },\n \"asr\": {\n \"multilingual\": true,\n \"strict_language\": true,\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"conversation\": {\n \"max_duration_seconds\": 1830,\n \"response_wait_ms\": 1150,\n \"response_max_wait_ms\": 2000,\n \"interruptible\": true,\n \"interruption_ignore_phrases\": [\n \"<string>\"\n ],\n \"speculative_response\": true,\n \"reengage_enabled\": true,\n \"hangup_after_seconds\": 1805,\n \"hangup_farewell_enabled\": true,\n \"record_audio\": true,\n \"timezone\": \"<string>\",\n \"transfer_destinations\": [\n {\n \"type\": \"phone\",\n \"label\": \"\",\n \"phone_number\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"description\": \"\",\n \"mode\": \"cold\",\n \"warm_connect\": \"confirm\",\n \"warm_briefing_instructions\": \"\",\n \"on_failure\": {\n \"action\": \"return_to_agent\",\n \"message\": \"\"\n }\n }\n ],\n \"outbound\": {\n \"amd_enabled\": true,\n \"voicemail\": {\n \"action\": \"hangup\",\n \"message\": \"\"\n }\n }\n },\n \"tools\": {\n \"enabled\": true,\n \"tool_ids\": [\n \"<string>\"\n ],\n \"system_tools\": {\n \"hang_up_call\": true\n }\n },\n \"webhooks\": {\n \"conversation_init\": {\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"timeout_seconds\": 5\n },\n \"post_call\": [\n {\n \"url\": \"<string>\",\n \"secret\": \"<string>\"\n }\n ]\n },\n \"knowledge_base\": {\n \"enabled\": true,\n \"knowledge_source_ids\": [\n \"<string>\"\n ]\n },\n \"analysis\": {\n \"summary\": {\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"language\": \"en\"\n },\n \"data_fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"text\",\n \"description\": \"\",\n \"enum_options\": [\n \"<string>\"\n ]\n }\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"\"\n }\n ]\n },\n \"guardrails\": {\n \"focus\": true,\n \"manipulation\": true\n },\n \"llm\": {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fish.audio/v1/agent/agents/{agent_id}/config")
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 \"prompt\": {\n \"system_prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\"\n },\n \"voice\": {\n \"voice_id\": \"<string>\",\n \"expressive\": true,\n \"speed\": 1.25\n },\n \"asr\": {\n \"multilingual\": true,\n \"strict_language\": true,\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"conversation\": {\n \"max_duration_seconds\": 1830,\n \"response_wait_ms\": 1150,\n \"response_max_wait_ms\": 2000,\n \"interruptible\": true,\n \"interruption_ignore_phrases\": [\n \"<string>\"\n ],\n \"speculative_response\": true,\n \"reengage_enabled\": true,\n \"hangup_after_seconds\": 1805,\n \"hangup_farewell_enabled\": true,\n \"record_audio\": true,\n \"timezone\": \"<string>\",\n \"transfer_destinations\": [\n {\n \"type\": \"phone\",\n \"label\": \"\",\n \"phone_number\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"description\": \"\",\n \"mode\": \"cold\",\n \"warm_connect\": \"confirm\",\n \"warm_briefing_instructions\": \"\",\n \"on_failure\": {\n \"action\": \"return_to_agent\",\n \"message\": \"\"\n }\n }\n ],\n \"outbound\": {\n \"amd_enabled\": true,\n \"voicemail\": {\n \"action\": \"hangup\",\n \"message\": \"\"\n }\n }\n },\n \"tools\": {\n \"enabled\": true,\n \"tool_ids\": [\n \"<string>\"\n ],\n \"system_tools\": {\n \"hang_up_call\": true\n }\n },\n \"webhooks\": {\n \"conversation_init\": {\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"timeout_seconds\": 5\n },\n \"post_call\": [\n {\n \"url\": \"<string>\",\n \"secret\": \"<string>\"\n }\n ]\n },\n \"knowledge_base\": {\n \"enabled\": true,\n \"knowledge_source_ids\": [\n \"<string>\"\n ]\n },\n \"analysis\": {\n \"summary\": {\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"language\": \"en\"\n },\n \"data_fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"text\",\n \"description\": \"\",\n \"enum_options\": [\n \"<string>\"\n ]\n }\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"\"\n }\n ]\n },\n \"guardrails\": {\n \"focus\": true,\n \"manipulation\": true\n },\n \"llm\": {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"config_hash": "<string>",
"prompt": {
"system_prompt": "",
"first_message_mode": "prompt",
"first_message": "Hi! Thanks for calling — how can I help you today?",
"first_message_prompt": "Greet the caller and ask what you can help with."
},
"voice": {
"voice_id": "b347db033a6549378b48d00acb0d06cd",
"speaking_language": "en",
"expressive": false,
"speed": 1
},
"asr": {
"model": "deepgram:nova-3",
"multilingual": false,
"strict_language": false,
"keyterms": [
"<string>"
]
},
"conversation": {
"max_duration_seconds": 1800,
"response_wait_ms": 550,
"eagerness": "balanced",
"response_max_wait_ms": 123,
"interruptible": true,
"interruption_sensitivity": "balanced",
"interruption_ignore_phrases": [],
"speculative_response": true,
"reengage_enabled": false,
"hangup_after_seconds": 60,
"hangup_farewell_enabled": false,
"record_audio": true,
"timezone": "",
"transfer_destinations": [],
"outbound": {
"amd_enabled": true,
"voicemail": {
"action": "hangup",
"message": ""
}
}
},
"tools": {
"enabled": true,
"tool_ids": [
"<string>"
],
"system_tools": {
"hang_up_call": false
}
},
"webhooks": {
"conversation_init": {
"url": "<string>",
"has_secret": false,
"timeout_seconds": 5
},
"post_call": [
{
"url": "<string>",
"has_secret": false
}
]
},
"knowledge_base": {
"enabled": false,
"knowledge_source_ids": [
"<string>"
]
},
"analysis": {
"summary": {
"enabled": true,
"prompt": "<string>",
"language": "en"
},
"data_fields": [
{
"name": "<string>",
"type": "text",
"description": "",
"enum_options": [
"<string>"
]
}
],
"criteria": [
{
"name": "<string>",
"description": ""
}
]
},
"guardrails": {
"focus": false,
"manipulation": false
},
"llm": {
"model": "google/gemini-3.6-flash",
"custom": {
"base_url": "<string>",
"model": "<string>",
"api_key": null
}
},
"updated_at": "2023-11-07T05:31:56Z"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}Agents
Update Draft Config
Patch the draft configuration section by section; omitted sections keep their value.
PATCH
/
v1
/
agent
/
agents
/
{agent_id}
/
config
Update Draft Config
curl --request PATCH \
--url https://api.fish.audio/v1/agent/agents/<agent-id>/config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"prompt": {
"system_prompt": "You are the receptionist for Fish Dental."
},
"webhooks": {
"post_call": [
{
"url": "https://example.com/hooks/fish",
"secret": "<signing-secret>"
}
]
}
}'import requests
url = "https://api.fish.audio/v1/agent/agents/{agent_id}/config"
payload = {
"prompt": {
"system_prompt": "<string>",
"first_message": "<string>",
"first_message_prompt": "<string>"
},
"voice": {
"voice_id": "<string>",
"expressive": True,
"speed": 1.25
},
"asr": {
"multilingual": True,
"strict_language": True,
"keyterms": ["<string>"]
},
"conversation": {
"max_duration_seconds": 1830,
"response_wait_ms": 1150,
"response_max_wait_ms": 2000,
"interruptible": True,
"interruption_ignore_phrases": ["<string>"],
"speculative_response": True,
"reengage_enabled": True,
"hangup_after_seconds": 1805,
"hangup_farewell_enabled": True,
"record_audio": True,
"timezone": "<string>",
"transfer_destinations": [
{
"type": "phone",
"label": "",
"phone_number": "<string>",
"sip_uri": "<string>",
"description": "",
"mode": "cold",
"warm_connect": "confirm",
"warm_briefing_instructions": "",
"on_failure": {
"action": "return_to_agent",
"message": ""
}
}
],
"outbound": {
"amd_enabled": True,
"voicemail": {
"action": "hangup",
"message": ""
}
}
},
"tools": {
"enabled": True,
"tool_ids": ["<string>"],
"system_tools": { "hang_up_call": True }
},
"webhooks": {
"conversation_init": {
"url": "<string>",
"secret": "<string>",
"timeout_seconds": 5
},
"post_call": [
{
"url": "<string>",
"secret": "<string>"
}
]
},
"knowledge_base": {
"enabled": True,
"knowledge_source_ids": ["<string>"]
},
"analysis": {
"summary": {
"enabled": True,
"prompt": "<string>",
"language": "en"
},
"data_fields": [
{
"name": "<string>",
"type": "text",
"description": "",
"enum_options": ["<string>"]
}
],
"criteria": [
{
"name": "<string>",
"description": ""
}
]
},
"guardrails": {
"focus": True,
"manipulation": True
},
"llm": { "custom": {
"base_url": "<string>",
"model": "<string>",
"api_key": "<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({
prompt: {
system_prompt: '<string>',
first_message: '<string>',
first_message_prompt: '<string>'
},
voice: {voice_id: '<string>', expressive: true, speed: 1.25},
asr: {multilingual: true, strict_language: true, keyterms: ['<string>']},
conversation: {
max_duration_seconds: 1830,
response_wait_ms: 1150,
response_max_wait_ms: 2000,
interruptible: true,
interruption_ignore_phrases: ['<string>'],
speculative_response: true,
reengage_enabled: true,
hangup_after_seconds: 1805,
hangup_farewell_enabled: true,
record_audio: true,
timezone: '<string>',
transfer_destinations: [
{
type: 'phone',
label: '',
phone_number: '<string>',
sip_uri: '<string>',
description: '',
mode: 'cold',
warm_connect: 'confirm',
warm_briefing_instructions: '',
on_failure: {action: 'return_to_agent', message: ''}
}
],
outbound: {amd_enabled: true, voicemail: {action: 'hangup', message: ''}}
},
tools: {enabled: true, tool_ids: ['<string>'], system_tools: {hang_up_call: true}},
webhooks: {
conversation_init: {url: '<string>', secret: '<string>', timeout_seconds: 5},
post_call: [{url: '<string>', secret: '<string>'}]
},
knowledge_base: {enabled: true, knowledge_source_ids: ['<string>']},
analysis: {
summary: {enabled: true, prompt: '<string>', language: 'en'},
data_fields: [{name: '<string>', type: 'text', description: '', enum_options: ['<string>']}],
criteria: [{name: '<string>', description: ''}]
},
guardrails: {focus: true, manipulation: true},
llm: {custom: {base_url: '<string>', model: '<string>', api_key: '<string>'}}
})
};
fetch('https://api.fish.audio/v1/agent/agents/{agent_id}/config', 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.fish.audio/v1/agent/agents/{agent_id}/config",
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([
'prompt' => [
'system_prompt' => '<string>',
'first_message' => '<string>',
'first_message_prompt' => '<string>'
],
'voice' => [
'voice_id' => '<string>',
'expressive' => true,
'speed' => 1.25
],
'asr' => [
'multilingual' => true,
'strict_language' => true,
'keyterms' => [
'<string>'
]
],
'conversation' => [
'max_duration_seconds' => 1830,
'response_wait_ms' => 1150,
'response_max_wait_ms' => 2000,
'interruptible' => true,
'interruption_ignore_phrases' => [
'<string>'
],
'speculative_response' => true,
'reengage_enabled' => true,
'hangup_after_seconds' => 1805,
'hangup_farewell_enabled' => true,
'record_audio' => true,
'timezone' => '<string>',
'transfer_destinations' => [
[
'type' => 'phone',
'label' => '',
'phone_number' => '<string>',
'sip_uri' => '<string>',
'description' => '',
'mode' => 'cold',
'warm_connect' => 'confirm',
'warm_briefing_instructions' => '',
'on_failure' => [
'action' => 'return_to_agent',
'message' => ''
]
]
],
'outbound' => [
'amd_enabled' => true,
'voicemail' => [
'action' => 'hangup',
'message' => ''
]
]
],
'tools' => [
'enabled' => true,
'tool_ids' => [
'<string>'
],
'system_tools' => [
'hang_up_call' => true
]
],
'webhooks' => [
'conversation_init' => [
'url' => '<string>',
'secret' => '<string>',
'timeout_seconds' => 5
],
'post_call' => [
[
'url' => '<string>',
'secret' => '<string>'
]
]
],
'knowledge_base' => [
'enabled' => true,
'knowledge_source_ids' => [
'<string>'
]
],
'analysis' => [
'summary' => [
'enabled' => true,
'prompt' => '<string>',
'language' => 'en'
],
'data_fields' => [
[
'name' => '<string>',
'type' => 'text',
'description' => '',
'enum_options' => [
'<string>'
]
]
],
'criteria' => [
[
'name' => '<string>',
'description' => ''
]
]
],
'guardrails' => [
'focus' => true,
'manipulation' => true
],
'llm' => [
'custom' => [
'base_url' => '<string>',
'model' => '<string>',
'api_key' => '<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.fish.audio/v1/agent/agents/{agent_id}/config"
payload := strings.NewReader("{\n \"prompt\": {\n \"system_prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\"\n },\n \"voice\": {\n \"voice_id\": \"<string>\",\n \"expressive\": true,\n \"speed\": 1.25\n },\n \"asr\": {\n \"multilingual\": true,\n \"strict_language\": true,\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"conversation\": {\n \"max_duration_seconds\": 1830,\n \"response_wait_ms\": 1150,\n \"response_max_wait_ms\": 2000,\n \"interruptible\": true,\n \"interruption_ignore_phrases\": [\n \"<string>\"\n ],\n \"speculative_response\": true,\n \"reengage_enabled\": true,\n \"hangup_after_seconds\": 1805,\n \"hangup_farewell_enabled\": true,\n \"record_audio\": true,\n \"timezone\": \"<string>\",\n \"transfer_destinations\": [\n {\n \"type\": \"phone\",\n \"label\": \"\",\n \"phone_number\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"description\": \"\",\n \"mode\": \"cold\",\n \"warm_connect\": \"confirm\",\n \"warm_briefing_instructions\": \"\",\n \"on_failure\": {\n \"action\": \"return_to_agent\",\n \"message\": \"\"\n }\n }\n ],\n \"outbound\": {\n \"amd_enabled\": true,\n \"voicemail\": {\n \"action\": \"hangup\",\n \"message\": \"\"\n }\n }\n },\n \"tools\": {\n \"enabled\": true,\n \"tool_ids\": [\n \"<string>\"\n ],\n \"system_tools\": {\n \"hang_up_call\": true\n }\n },\n \"webhooks\": {\n \"conversation_init\": {\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"timeout_seconds\": 5\n },\n \"post_call\": [\n {\n \"url\": \"<string>\",\n \"secret\": \"<string>\"\n }\n ]\n },\n \"knowledge_base\": {\n \"enabled\": true,\n \"knowledge_source_ids\": [\n \"<string>\"\n ]\n },\n \"analysis\": {\n \"summary\": {\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"language\": \"en\"\n },\n \"data_fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"text\",\n \"description\": \"\",\n \"enum_options\": [\n \"<string>\"\n ]\n }\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"\"\n }\n ]\n },\n \"guardrails\": {\n \"focus\": true,\n \"manipulation\": true\n },\n \"llm\": {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\"\n }\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://api.fish.audio/v1/agent/agents/{agent_id}/config")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": {\n \"system_prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\"\n },\n \"voice\": {\n \"voice_id\": \"<string>\",\n \"expressive\": true,\n \"speed\": 1.25\n },\n \"asr\": {\n \"multilingual\": true,\n \"strict_language\": true,\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"conversation\": {\n \"max_duration_seconds\": 1830,\n \"response_wait_ms\": 1150,\n \"response_max_wait_ms\": 2000,\n \"interruptible\": true,\n \"interruption_ignore_phrases\": [\n \"<string>\"\n ],\n \"speculative_response\": true,\n \"reengage_enabled\": true,\n \"hangup_after_seconds\": 1805,\n \"hangup_farewell_enabled\": true,\n \"record_audio\": true,\n \"timezone\": \"<string>\",\n \"transfer_destinations\": [\n {\n \"type\": \"phone\",\n \"label\": \"\",\n \"phone_number\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"description\": \"\",\n \"mode\": \"cold\",\n \"warm_connect\": \"confirm\",\n \"warm_briefing_instructions\": \"\",\n \"on_failure\": {\n \"action\": \"return_to_agent\",\n \"message\": \"\"\n }\n }\n ],\n \"outbound\": {\n \"amd_enabled\": true,\n \"voicemail\": {\n \"action\": \"hangup\",\n \"message\": \"\"\n }\n }\n },\n \"tools\": {\n \"enabled\": true,\n \"tool_ids\": [\n \"<string>\"\n ],\n \"system_tools\": {\n \"hang_up_call\": true\n }\n },\n \"webhooks\": {\n \"conversation_init\": {\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"timeout_seconds\": 5\n },\n \"post_call\": [\n {\n \"url\": \"<string>\",\n \"secret\": \"<string>\"\n }\n ]\n },\n \"knowledge_base\": {\n \"enabled\": true,\n \"knowledge_source_ids\": [\n \"<string>\"\n ]\n },\n \"analysis\": {\n \"summary\": {\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"language\": \"en\"\n },\n \"data_fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"text\",\n \"description\": \"\",\n \"enum_options\": [\n \"<string>\"\n ]\n }\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"\"\n }\n ]\n },\n \"guardrails\": {\n \"focus\": true,\n \"manipulation\": true\n },\n \"llm\": {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fish.audio/v1/agent/agents/{agent_id}/config")
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 \"prompt\": {\n \"system_prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\"\n },\n \"voice\": {\n \"voice_id\": \"<string>\",\n \"expressive\": true,\n \"speed\": 1.25\n },\n \"asr\": {\n \"multilingual\": true,\n \"strict_language\": true,\n \"keyterms\": [\n \"<string>\"\n ]\n },\n \"conversation\": {\n \"max_duration_seconds\": 1830,\n \"response_wait_ms\": 1150,\n \"response_max_wait_ms\": 2000,\n \"interruptible\": true,\n \"interruption_ignore_phrases\": [\n \"<string>\"\n ],\n \"speculative_response\": true,\n \"reengage_enabled\": true,\n \"hangup_after_seconds\": 1805,\n \"hangup_farewell_enabled\": true,\n \"record_audio\": true,\n \"timezone\": \"<string>\",\n \"transfer_destinations\": [\n {\n \"type\": \"phone\",\n \"label\": \"\",\n \"phone_number\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"description\": \"\",\n \"mode\": \"cold\",\n \"warm_connect\": \"confirm\",\n \"warm_briefing_instructions\": \"\",\n \"on_failure\": {\n \"action\": \"return_to_agent\",\n \"message\": \"\"\n }\n }\n ],\n \"outbound\": {\n \"amd_enabled\": true,\n \"voicemail\": {\n \"action\": \"hangup\",\n \"message\": \"\"\n }\n }\n },\n \"tools\": {\n \"enabled\": true,\n \"tool_ids\": [\n \"<string>\"\n ],\n \"system_tools\": {\n \"hang_up_call\": true\n }\n },\n \"webhooks\": {\n \"conversation_init\": {\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"timeout_seconds\": 5\n },\n \"post_call\": [\n {\n \"url\": \"<string>\",\n \"secret\": \"<string>\"\n }\n ]\n },\n \"knowledge_base\": {\n \"enabled\": true,\n \"knowledge_source_ids\": [\n \"<string>\"\n ]\n },\n \"analysis\": {\n \"summary\": {\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"language\": \"en\"\n },\n \"data_fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"text\",\n \"description\": \"\",\n \"enum_options\": [\n \"<string>\"\n ]\n }\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"description\": \"\"\n }\n ]\n },\n \"guardrails\": {\n \"focus\": true,\n \"manipulation\": true\n },\n \"llm\": {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"config_hash": "<string>",
"prompt": {
"system_prompt": "",
"first_message_mode": "prompt",
"first_message": "Hi! Thanks for calling — how can I help you today?",
"first_message_prompt": "Greet the caller and ask what you can help with."
},
"voice": {
"voice_id": "b347db033a6549378b48d00acb0d06cd",
"speaking_language": "en",
"expressive": false,
"speed": 1
},
"asr": {
"model": "deepgram:nova-3",
"multilingual": false,
"strict_language": false,
"keyterms": [
"<string>"
]
},
"conversation": {
"max_duration_seconds": 1800,
"response_wait_ms": 550,
"eagerness": "balanced",
"response_max_wait_ms": 123,
"interruptible": true,
"interruption_sensitivity": "balanced",
"interruption_ignore_phrases": [],
"speculative_response": true,
"reengage_enabled": false,
"hangup_after_seconds": 60,
"hangup_farewell_enabled": false,
"record_audio": true,
"timezone": "",
"transfer_destinations": [],
"outbound": {
"amd_enabled": true,
"voicemail": {
"action": "hangup",
"message": ""
}
}
},
"tools": {
"enabled": true,
"tool_ids": [
"<string>"
],
"system_tools": {
"hang_up_call": false
}
},
"webhooks": {
"conversation_init": {
"url": "<string>",
"has_secret": false,
"timeout_seconds": 5
},
"post_call": [
{
"url": "<string>",
"has_secret": false
}
]
},
"knowledge_base": {
"enabled": false,
"knowledge_source_ids": [
"<string>"
]
},
"analysis": {
"summary": {
"enabled": true,
"prompt": "<string>",
"language": "en"
},
"data_fields": [
{
"name": "<string>",
"type": "text",
"description": "",
"enum_options": [
"<string>"
]
}
],
"criteria": [
{
"name": "<string>",
"description": ""
}
]
},
"guardrails": {
"focus": false,
"manipulation": false
},
"llm": {
"model": "google/gemini-3.6-flash",
"custom": {
"base_url": "<string>",
"model": "<string>",
"api_key": null
}
},
"updated_at": "2023-11-07T05:31:56Z"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Request fulfilled, document follows
Content hash of the draft; equal to a version's config_hash when the draft has no unpublished changes.
Show child attributes
Show child attributes
Read shape of the voice section. The ASR fields that moved to the asr section stay mirrored here, deprecated, so clients written before the split keep reading them.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?