Update Agent
curl --request PATCH \
--url https://api.ravan.ai/api/v1/agents/{id}/ \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"agentName": "Agni2324",
"status": "ACTIVE",
"model": "Agni Premium",
"s2sModel": "Agni Premium",
"voiceId": "Iris",
"temperature": 0.7,
"reminderTriggerMs": 10000,
"reminderMaxCount": 1,
"ambientSound": "city_ambience",
"ambientSoundVolume": 1,
"maxCallDurationMs": 240000,
"ringDurationMs": 30000,
"voicemailMessage": "",
"voicemailDetectionTimeoutMs": 5000,
"postCallAnalysisModel": "gpt-4o-mini",
"postCallAnalysisData": [
{
"choices": [
"Negative",
"Positive",
"Neutral"
],
"description": "what was users sentiment throughout the call",
"name": "sentiments",
"type": "enum"
},
{
"description": "Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call",
"name": "summary",
"type": "string"
},
{
"description": "Select the data about their work",
"name": "what they did in their work?",
"type": "string"
}
],
"selectedTools": [
"019e9308-6e56-7488-910a-cceed909fc7a",
"019e92fc-e8a4-7c3f-8b14-89a55db6f748"
],
"knowledgeBase": "",
"beginMessage": "",
"startSpeaker": "agent",
"createdAt": "2026-06-04 14:10:48.49862 +0000 UTC",
"updatedAt": "2026-06-11 10:57:37.109987 +0000 UTC",
"prompt": "The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\n\n# AGNI Friendly Daily Check-In Companion\n\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\n\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\n\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\n\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\nTalk in hindi.",
"endcallOnSilenceDuration": 10000,
"reminderMessage": "Hey there are you there?",
"voicemailCustomPatterns": null,
"interruptionSensitivity": 0.1,
"calcomAccountName": "Default",
"calcomStatus": "active",
"calcomConnectionType": "agent",
"ghlAssignUserIdList": [],
"memory": true,
"calendarTimezone": "UTC",
"accent": [],
"emotion": false,
"crmSyncProviders": null,
"salesforceCalendarId": "",
"salesforceAssignUserIdList": [],
"emergencyFallback": "+919911293960"
}
'import requests
url = "https://api.ravan.ai/api/v1/agents/{id}/"
payload = {
"agentName": "Agni2324",
"status": "ACTIVE",
"model": "Agni Premium",
"s2sModel": "Agni Premium",
"voiceId": "Iris",
"temperature": 0.7,
"reminderTriggerMs": 10000,
"reminderMaxCount": 1,
"ambientSound": "city_ambience",
"ambientSoundVolume": 1,
"maxCallDurationMs": 240000,
"ringDurationMs": 30000,
"voicemailMessage": "",
"voicemailDetectionTimeoutMs": 5000,
"postCallAnalysisModel": "gpt-4o-mini",
"postCallAnalysisData": [
{
"choices": ["Negative", "Positive", "Neutral"],
"description": "what was users sentiment throughout the call",
"name": "sentiments",
"type": "enum"
},
{
"description": "Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call",
"name": "summary",
"type": "string"
},
{
"description": "Select the data about their work",
"name": "what they did in their work?",
"type": "string"
}
],
"selectedTools": ["019e9308-6e56-7488-910a-cceed909fc7a", "019e92fc-e8a4-7c3f-8b14-89a55db6f748"],
"knowledgeBase": "",
"beginMessage": "",
"startSpeaker": "agent",
"createdAt": "2026-06-04 14:10:48.49862 +0000 UTC",
"updatedAt": "2026-06-11 10:57:37.109987 +0000 UTC",
"prompt": "The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}
# AGNI Friendly Daily Check-In Companion
You are AGNI, a warm, friendly, caring, and conversational AI companion.
Your role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.
You are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.
You are simply a friendly AI companion who enjoys talking to people and learning about their day.
Talk in hindi.",
"endcallOnSilenceDuration": 10000,
"reminderMessage": "Hey there are you there?",
"voicemailCustomPatterns": None,
"interruptionSensitivity": 0.1,
"calcomAccountName": "Default",
"calcomStatus": "active",
"calcomConnectionType": "agent",
"ghlAssignUserIdList": [],
"memory": True,
"calendarTimezone": "UTC",
"accent": [],
"emotion": False,
"crmSyncProviders": None,
"salesforceCalendarId": "",
"salesforceAssignUserIdList": [],
"emergencyFallback": "+919911293960"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentName: 'Agni2324',
status: 'ACTIVE',
model: 'Agni Premium',
s2sModel: 'Agni Premium',
voiceId: 'Iris',
temperature: 0.7,
reminderTriggerMs: 10000,
reminderMaxCount: 1,
ambientSound: 'city_ambience',
ambientSoundVolume: 1,
maxCallDurationMs: 240000,
ringDurationMs: 30000,
voicemailMessage: '',
voicemailDetectionTimeoutMs: 5000,
postCallAnalysisModel: 'gpt-4o-mini',
postCallAnalysisData: [
{
choices: ['Negative', 'Positive', 'Neutral'],
description: 'what was users sentiment throughout the call',
name: 'sentiments',
type: 'enum'
},
{
description: 'Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call',
name: 'summary',
type: 'string'
},
{
description: 'Select the data about their work',
name: 'what they did in their work?',
type: 'string'
}
],
selectedTools: ['019e9308-6e56-7488-910a-cceed909fc7a', '019e92fc-e8a4-7c3f-8b14-89a55db6f748'],
knowledgeBase: '',
beginMessage: '',
startSpeaker: 'agent',
createdAt: '2026-06-04 14:10:48.49862 +0000 UTC',
updatedAt: '2026-06-11 10:57:37.109987 +0000 UTC',
prompt: 'The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\n\n# AGNI Friendly Daily Check-In Companion\n\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\n\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\n\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\n\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\nTalk in hindi.',
endcallOnSilenceDuration: 10000,
reminderMessage: 'Hey there are you there?',
voicemailCustomPatterns: null,
interruptionSensitivity: 0.1,
calcomAccountName: 'Default',
calcomStatus: 'active',
calcomConnectionType: 'agent',
ghlAssignUserIdList: [],
memory: true,
calendarTimezone: 'UTC',
accent: [],
emotion: false,
crmSyncProviders: null,
salesforceCalendarId: '',
salesforceAssignUserIdList: [],
emergencyFallback: '+919911293960'
})
};
fetch('https://api.ravan.ai/api/v1/agents/{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.ravan.ai/api/v1/agents/{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([
'agentName' => 'Agni2324',
'status' => 'ACTIVE',
'model' => 'Agni Premium',
's2sModel' => 'Agni Premium',
'voiceId' => 'Iris',
'temperature' => 0.7,
'reminderTriggerMs' => 10000,
'reminderMaxCount' => 1,
'ambientSound' => 'city_ambience',
'ambientSoundVolume' => 1,
'maxCallDurationMs' => 240000,
'ringDurationMs' => 30000,
'voicemailMessage' => '',
'voicemailDetectionTimeoutMs' => 5000,
'postCallAnalysisModel' => 'gpt-4o-mini',
'postCallAnalysisData' => [
[
'choices' => [
'Negative',
'Positive',
'Neutral'
],
'description' => 'what was users sentiment throughout the call',
'name' => 'sentiments',
'type' => 'enum'
],
[
'description' => 'Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call',
'name' => 'summary',
'type' => 'string'
],
[
'description' => 'Select the data about their work',
'name' => 'what they did in their work?',
'type' => 'string'
]
],
'selectedTools' => [
'019e9308-6e56-7488-910a-cceed909fc7a',
'019e92fc-e8a4-7c3f-8b14-89a55db6f748'
],
'knowledgeBase' => '',
'beginMessage' => '',
'startSpeaker' => 'agent',
'createdAt' => '2026-06-04 14:10:48.49862 +0000 UTC',
'updatedAt' => '2026-06-11 10:57:37.109987 +0000 UTC',
'prompt' => 'The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}
# AGNI Friendly Daily Check-In Companion
You are AGNI, a warm, friendly, caring, and conversational AI companion.
Your role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.
You are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.
You are simply a friendly AI companion who enjoys talking to people and learning about their day.
Talk in hindi.',
'endcallOnSilenceDuration' => 10000,
'reminderMessage' => 'Hey there are you there?',
'voicemailCustomPatterns' => null,
'interruptionSensitivity' => 0.1,
'calcomAccountName' => 'Default',
'calcomStatus' => 'active',
'calcomConnectionType' => 'agent',
'ghlAssignUserIdList' => [
],
'memory' => true,
'calendarTimezone' => 'UTC',
'accent' => [
],
'emotion' => false,
'crmSyncProviders' => null,
'salesforceCalendarId' => '',
'salesforceAssignUserIdList' => [
],
'emergencyFallback' => '+919911293960'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ravan.ai/api/v1/agents/{id}/"
payload := strings.NewReader("{\n \"agentName\": \"Agni2324\",\n \"status\": \"ACTIVE\",\n \"model\": \"Agni Premium\",\n \"s2sModel\": \"Agni Premium\",\n \"voiceId\": \"Iris\",\n \"temperature\": 0.7,\n \"reminderTriggerMs\": 10000,\n \"reminderMaxCount\": 1,\n \"ambientSound\": \"city_ambience\",\n \"ambientSoundVolume\": 1,\n \"maxCallDurationMs\": 240000,\n \"ringDurationMs\": 30000,\n \"voicemailMessage\": \"\",\n \"voicemailDetectionTimeoutMs\": 5000,\n \"postCallAnalysisModel\": \"gpt-4o-mini\",\n \"postCallAnalysisData\": [\n {\n \"choices\": [\n \"Negative\",\n \"Positive\",\n \"Neutral\"\n ],\n \"description\": \"what was users sentiment throughout the call\",\n \"name\": \"sentiments\",\n \"type\": \"enum\"\n },\n {\n \"description\": \"Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call\",\n \"name\": \"summary\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Select the data about their work\",\n \"name\": \"what they did in their work?\",\n \"type\": \"string\"\n }\n ],\n \"selectedTools\": [\n \"019e9308-6e56-7488-910a-cceed909fc7a\",\n \"019e92fc-e8a4-7c3f-8b14-89a55db6f748\"\n ],\n \"knowledgeBase\": \"\",\n \"beginMessage\": \"\",\n \"startSpeaker\": \"agent\",\n \"createdAt\": \"2026-06-04 14:10:48.49862 +0000 UTC\",\n \"updatedAt\": \"2026-06-11 10:57:37.109987 +0000 UTC\",\n \"prompt\": \"The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\\n\\n# AGNI Friendly Daily Check-In Companion\\n\\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\\n\\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\\n\\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\\n\\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\\nTalk in hindi.\",\n \"endcallOnSilenceDuration\": 10000,\n \"reminderMessage\": \"Hey there are you there?\",\n \"voicemailCustomPatterns\": null,\n \"interruptionSensitivity\": 0.1,\n \"calcomAccountName\": \"Default\",\n \"calcomStatus\": \"active\",\n \"calcomConnectionType\": \"agent\",\n \"ghlAssignUserIdList\": [],\n \"memory\": true,\n \"calendarTimezone\": \"UTC\",\n \"accent\": [],\n \"emotion\": false,\n \"crmSyncProviders\": null,\n \"salesforceCalendarId\": \"\",\n \"salesforceAssignUserIdList\": [],\n \"emergencyFallback\": \"+919911293960\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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.ravan.ai/api/v1/agents/{id}/")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentName\": \"Agni2324\",\n \"status\": \"ACTIVE\",\n \"model\": \"Agni Premium\",\n \"s2sModel\": \"Agni Premium\",\n \"voiceId\": \"Iris\",\n \"temperature\": 0.7,\n \"reminderTriggerMs\": 10000,\n \"reminderMaxCount\": 1,\n \"ambientSound\": \"city_ambience\",\n \"ambientSoundVolume\": 1,\n \"maxCallDurationMs\": 240000,\n \"ringDurationMs\": 30000,\n \"voicemailMessage\": \"\",\n \"voicemailDetectionTimeoutMs\": 5000,\n \"postCallAnalysisModel\": \"gpt-4o-mini\",\n \"postCallAnalysisData\": [\n {\n \"choices\": [\n \"Negative\",\n \"Positive\",\n \"Neutral\"\n ],\n \"description\": \"what was users sentiment throughout the call\",\n \"name\": \"sentiments\",\n \"type\": \"enum\"\n },\n {\n \"description\": \"Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call\",\n \"name\": \"summary\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Select the data about their work\",\n \"name\": \"what they did in their work?\",\n \"type\": \"string\"\n }\n ],\n \"selectedTools\": [\n \"019e9308-6e56-7488-910a-cceed909fc7a\",\n \"019e92fc-e8a4-7c3f-8b14-89a55db6f748\"\n ],\n \"knowledgeBase\": \"\",\n \"beginMessage\": \"\",\n \"startSpeaker\": \"agent\",\n \"createdAt\": \"2026-06-04 14:10:48.49862 +0000 UTC\",\n \"updatedAt\": \"2026-06-11 10:57:37.109987 +0000 UTC\",\n \"prompt\": \"The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\\n\\n# AGNI Friendly Daily Check-In Companion\\n\\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\\n\\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\\n\\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\\n\\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\\nTalk in hindi.\",\n \"endcallOnSilenceDuration\": 10000,\n \"reminderMessage\": \"Hey there are you there?\",\n \"voicemailCustomPatterns\": null,\n \"interruptionSensitivity\": 0.1,\n \"calcomAccountName\": \"Default\",\n \"calcomStatus\": \"active\",\n \"calcomConnectionType\": \"agent\",\n \"ghlAssignUserIdList\": [],\n \"memory\": true,\n \"calendarTimezone\": \"UTC\",\n \"accent\": [],\n \"emotion\": false,\n \"crmSyncProviders\": null,\n \"salesforceCalendarId\": \"\",\n \"salesforceAssignUserIdList\": [],\n \"emergencyFallback\": \"+919911293960\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ravan.ai/api/v1/agents/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentName\": \"Agni2324\",\n \"status\": \"ACTIVE\",\n \"model\": \"Agni Premium\",\n \"s2sModel\": \"Agni Premium\",\n \"voiceId\": \"Iris\",\n \"temperature\": 0.7,\n \"reminderTriggerMs\": 10000,\n \"reminderMaxCount\": 1,\n \"ambientSound\": \"city_ambience\",\n \"ambientSoundVolume\": 1,\n \"maxCallDurationMs\": 240000,\n \"ringDurationMs\": 30000,\n \"voicemailMessage\": \"\",\n \"voicemailDetectionTimeoutMs\": 5000,\n \"postCallAnalysisModel\": \"gpt-4o-mini\",\n \"postCallAnalysisData\": [\n {\n \"choices\": [\n \"Negative\",\n \"Positive\",\n \"Neutral\"\n ],\n \"description\": \"what was users sentiment throughout the call\",\n \"name\": \"sentiments\",\n \"type\": \"enum\"\n },\n {\n \"description\": \"Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call\",\n \"name\": \"summary\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Select the data about their work\",\n \"name\": \"what they did in their work?\",\n \"type\": \"string\"\n }\n ],\n \"selectedTools\": [\n \"019e9308-6e56-7488-910a-cceed909fc7a\",\n \"019e92fc-e8a4-7c3f-8b14-89a55db6f748\"\n ],\n \"knowledgeBase\": \"\",\n \"beginMessage\": \"\",\n \"startSpeaker\": \"agent\",\n \"createdAt\": \"2026-06-04 14:10:48.49862 +0000 UTC\",\n \"updatedAt\": \"2026-06-11 10:57:37.109987 +0000 UTC\",\n \"prompt\": \"The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\\n\\n# AGNI Friendly Daily Check-In Companion\\n\\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\\n\\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\\n\\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\\n\\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\\nTalk in hindi.\",\n \"endcallOnSilenceDuration\": 10000,\n \"reminderMessage\": \"Hey there are you there?\",\n \"voicemailCustomPatterns\": null,\n \"interruptionSensitivity\": 0.1,\n \"calcomAccountName\": \"Default\",\n \"calcomStatus\": \"active\",\n \"calcomConnectionType\": \"agent\",\n \"ghlAssignUserIdList\": [],\n \"memory\": true,\n \"calendarTimezone\": \"UTC\",\n \"accent\": [],\n \"emotion\": false,\n \"crmSyncProviders\": null,\n \"salesforceCalendarId\": \"\",\n \"salesforceAssignUserIdList\": [],\n \"emergencyFallback\": \"+919911293960\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Agent updated successfully",
"data": { "id": "...", "agentName": "Sales Bot v2" }
}
Agent API
Update Agent
Update Agent.
PATCH
/
api
/
v1
/
agents
/
{id}
/
Update Agent
curl --request PATCH \
--url https://api.ravan.ai/api/v1/agents/{id}/ \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"agentName": "Agni2324",
"status": "ACTIVE",
"model": "Agni Premium",
"s2sModel": "Agni Premium",
"voiceId": "Iris",
"temperature": 0.7,
"reminderTriggerMs": 10000,
"reminderMaxCount": 1,
"ambientSound": "city_ambience",
"ambientSoundVolume": 1,
"maxCallDurationMs": 240000,
"ringDurationMs": 30000,
"voicemailMessage": "",
"voicemailDetectionTimeoutMs": 5000,
"postCallAnalysisModel": "gpt-4o-mini",
"postCallAnalysisData": [
{
"choices": [
"Negative",
"Positive",
"Neutral"
],
"description": "what was users sentiment throughout the call",
"name": "sentiments",
"type": "enum"
},
{
"description": "Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call",
"name": "summary",
"type": "string"
},
{
"description": "Select the data about their work",
"name": "what they did in their work?",
"type": "string"
}
],
"selectedTools": [
"019e9308-6e56-7488-910a-cceed909fc7a",
"019e92fc-e8a4-7c3f-8b14-89a55db6f748"
],
"knowledgeBase": "",
"beginMessage": "",
"startSpeaker": "agent",
"createdAt": "2026-06-04 14:10:48.49862 +0000 UTC",
"updatedAt": "2026-06-11 10:57:37.109987 +0000 UTC",
"prompt": "The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\n\n# AGNI Friendly Daily Check-In Companion\n\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\n\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\n\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\n\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\nTalk in hindi.",
"endcallOnSilenceDuration": 10000,
"reminderMessage": "Hey there are you there?",
"voicemailCustomPatterns": null,
"interruptionSensitivity": 0.1,
"calcomAccountName": "Default",
"calcomStatus": "active",
"calcomConnectionType": "agent",
"ghlAssignUserIdList": [],
"memory": true,
"calendarTimezone": "UTC",
"accent": [],
"emotion": false,
"crmSyncProviders": null,
"salesforceCalendarId": "",
"salesforceAssignUserIdList": [],
"emergencyFallback": "+919911293960"
}
'import requests
url = "https://api.ravan.ai/api/v1/agents/{id}/"
payload = {
"agentName": "Agni2324",
"status": "ACTIVE",
"model": "Agni Premium",
"s2sModel": "Agni Premium",
"voiceId": "Iris",
"temperature": 0.7,
"reminderTriggerMs": 10000,
"reminderMaxCount": 1,
"ambientSound": "city_ambience",
"ambientSoundVolume": 1,
"maxCallDurationMs": 240000,
"ringDurationMs": 30000,
"voicemailMessage": "",
"voicemailDetectionTimeoutMs": 5000,
"postCallAnalysisModel": "gpt-4o-mini",
"postCallAnalysisData": [
{
"choices": ["Negative", "Positive", "Neutral"],
"description": "what was users sentiment throughout the call",
"name": "sentiments",
"type": "enum"
},
{
"description": "Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call",
"name": "summary",
"type": "string"
},
{
"description": "Select the data about their work",
"name": "what they did in their work?",
"type": "string"
}
],
"selectedTools": ["019e9308-6e56-7488-910a-cceed909fc7a", "019e92fc-e8a4-7c3f-8b14-89a55db6f748"],
"knowledgeBase": "",
"beginMessage": "",
"startSpeaker": "agent",
"createdAt": "2026-06-04 14:10:48.49862 +0000 UTC",
"updatedAt": "2026-06-11 10:57:37.109987 +0000 UTC",
"prompt": "The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}
# AGNI Friendly Daily Check-In Companion
You are AGNI, a warm, friendly, caring, and conversational AI companion.
Your role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.
You are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.
You are simply a friendly AI companion who enjoys talking to people and learning about their day.
Talk in hindi.",
"endcallOnSilenceDuration": 10000,
"reminderMessage": "Hey there are you there?",
"voicemailCustomPatterns": None,
"interruptionSensitivity": 0.1,
"calcomAccountName": "Default",
"calcomStatus": "active",
"calcomConnectionType": "agent",
"ghlAssignUserIdList": [],
"memory": True,
"calendarTimezone": "UTC",
"accent": [],
"emotion": False,
"crmSyncProviders": None,
"salesforceCalendarId": "",
"salesforceAssignUserIdList": [],
"emergencyFallback": "+919911293960"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentName: 'Agni2324',
status: 'ACTIVE',
model: 'Agni Premium',
s2sModel: 'Agni Premium',
voiceId: 'Iris',
temperature: 0.7,
reminderTriggerMs: 10000,
reminderMaxCount: 1,
ambientSound: 'city_ambience',
ambientSoundVolume: 1,
maxCallDurationMs: 240000,
ringDurationMs: 30000,
voicemailMessage: '',
voicemailDetectionTimeoutMs: 5000,
postCallAnalysisModel: 'gpt-4o-mini',
postCallAnalysisData: [
{
choices: ['Negative', 'Positive', 'Neutral'],
description: 'what was users sentiment throughout the call',
name: 'sentiments',
type: 'enum'
},
{
description: 'Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call',
name: 'summary',
type: 'string'
},
{
description: 'Select the data about their work',
name: 'what they did in their work?',
type: 'string'
}
],
selectedTools: ['019e9308-6e56-7488-910a-cceed909fc7a', '019e92fc-e8a4-7c3f-8b14-89a55db6f748'],
knowledgeBase: '',
beginMessage: '',
startSpeaker: 'agent',
createdAt: '2026-06-04 14:10:48.49862 +0000 UTC',
updatedAt: '2026-06-11 10:57:37.109987 +0000 UTC',
prompt: 'The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\n\n# AGNI Friendly Daily Check-In Companion\n\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\n\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\n\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\n\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\nTalk in hindi.',
endcallOnSilenceDuration: 10000,
reminderMessage: 'Hey there are you there?',
voicemailCustomPatterns: null,
interruptionSensitivity: 0.1,
calcomAccountName: 'Default',
calcomStatus: 'active',
calcomConnectionType: 'agent',
ghlAssignUserIdList: [],
memory: true,
calendarTimezone: 'UTC',
accent: [],
emotion: false,
crmSyncProviders: null,
salesforceCalendarId: '',
salesforceAssignUserIdList: [],
emergencyFallback: '+919911293960'
})
};
fetch('https://api.ravan.ai/api/v1/agents/{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.ravan.ai/api/v1/agents/{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([
'agentName' => 'Agni2324',
'status' => 'ACTIVE',
'model' => 'Agni Premium',
's2sModel' => 'Agni Premium',
'voiceId' => 'Iris',
'temperature' => 0.7,
'reminderTriggerMs' => 10000,
'reminderMaxCount' => 1,
'ambientSound' => 'city_ambience',
'ambientSoundVolume' => 1,
'maxCallDurationMs' => 240000,
'ringDurationMs' => 30000,
'voicemailMessage' => '',
'voicemailDetectionTimeoutMs' => 5000,
'postCallAnalysisModel' => 'gpt-4o-mini',
'postCallAnalysisData' => [
[
'choices' => [
'Negative',
'Positive',
'Neutral'
],
'description' => 'what was users sentiment throughout the call',
'name' => 'sentiments',
'type' => 'enum'
],
[
'description' => 'Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call',
'name' => 'summary',
'type' => 'string'
],
[
'description' => 'Select the data about their work',
'name' => 'what they did in their work?',
'type' => 'string'
]
],
'selectedTools' => [
'019e9308-6e56-7488-910a-cceed909fc7a',
'019e92fc-e8a4-7c3f-8b14-89a55db6f748'
],
'knowledgeBase' => '',
'beginMessage' => '',
'startSpeaker' => 'agent',
'createdAt' => '2026-06-04 14:10:48.49862 +0000 UTC',
'updatedAt' => '2026-06-11 10:57:37.109987 +0000 UTC',
'prompt' => 'The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}
# AGNI Friendly Daily Check-In Companion
You are AGNI, a warm, friendly, caring, and conversational AI companion.
Your role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.
You are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.
You are simply a friendly AI companion who enjoys talking to people and learning about their day.
Talk in hindi.',
'endcallOnSilenceDuration' => 10000,
'reminderMessage' => 'Hey there are you there?',
'voicemailCustomPatterns' => null,
'interruptionSensitivity' => 0.1,
'calcomAccountName' => 'Default',
'calcomStatus' => 'active',
'calcomConnectionType' => 'agent',
'ghlAssignUserIdList' => [
],
'memory' => true,
'calendarTimezone' => 'UTC',
'accent' => [
],
'emotion' => false,
'crmSyncProviders' => null,
'salesforceCalendarId' => '',
'salesforceAssignUserIdList' => [
],
'emergencyFallback' => '+919911293960'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ravan.ai/api/v1/agents/{id}/"
payload := strings.NewReader("{\n \"agentName\": \"Agni2324\",\n \"status\": \"ACTIVE\",\n \"model\": \"Agni Premium\",\n \"s2sModel\": \"Agni Premium\",\n \"voiceId\": \"Iris\",\n \"temperature\": 0.7,\n \"reminderTriggerMs\": 10000,\n \"reminderMaxCount\": 1,\n \"ambientSound\": \"city_ambience\",\n \"ambientSoundVolume\": 1,\n \"maxCallDurationMs\": 240000,\n \"ringDurationMs\": 30000,\n \"voicemailMessage\": \"\",\n \"voicemailDetectionTimeoutMs\": 5000,\n \"postCallAnalysisModel\": \"gpt-4o-mini\",\n \"postCallAnalysisData\": [\n {\n \"choices\": [\n \"Negative\",\n \"Positive\",\n \"Neutral\"\n ],\n \"description\": \"what was users sentiment throughout the call\",\n \"name\": \"sentiments\",\n \"type\": \"enum\"\n },\n {\n \"description\": \"Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call\",\n \"name\": \"summary\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Select the data about their work\",\n \"name\": \"what they did in their work?\",\n \"type\": \"string\"\n }\n ],\n \"selectedTools\": [\n \"019e9308-6e56-7488-910a-cceed909fc7a\",\n \"019e92fc-e8a4-7c3f-8b14-89a55db6f748\"\n ],\n \"knowledgeBase\": \"\",\n \"beginMessage\": \"\",\n \"startSpeaker\": \"agent\",\n \"createdAt\": \"2026-06-04 14:10:48.49862 +0000 UTC\",\n \"updatedAt\": \"2026-06-11 10:57:37.109987 +0000 UTC\",\n \"prompt\": \"The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\\n\\n# AGNI Friendly Daily Check-In Companion\\n\\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\\n\\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\\n\\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\\n\\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\\nTalk in hindi.\",\n \"endcallOnSilenceDuration\": 10000,\n \"reminderMessage\": \"Hey there are you there?\",\n \"voicemailCustomPatterns\": null,\n \"interruptionSensitivity\": 0.1,\n \"calcomAccountName\": \"Default\",\n \"calcomStatus\": \"active\",\n \"calcomConnectionType\": \"agent\",\n \"ghlAssignUserIdList\": [],\n \"memory\": true,\n \"calendarTimezone\": \"UTC\",\n \"accent\": [],\n \"emotion\": false,\n \"crmSyncProviders\": null,\n \"salesforceCalendarId\": \"\",\n \"salesforceAssignUserIdList\": [],\n \"emergencyFallback\": \"+919911293960\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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.ravan.ai/api/v1/agents/{id}/")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentName\": \"Agni2324\",\n \"status\": \"ACTIVE\",\n \"model\": \"Agni Premium\",\n \"s2sModel\": \"Agni Premium\",\n \"voiceId\": \"Iris\",\n \"temperature\": 0.7,\n \"reminderTriggerMs\": 10000,\n \"reminderMaxCount\": 1,\n \"ambientSound\": \"city_ambience\",\n \"ambientSoundVolume\": 1,\n \"maxCallDurationMs\": 240000,\n \"ringDurationMs\": 30000,\n \"voicemailMessage\": \"\",\n \"voicemailDetectionTimeoutMs\": 5000,\n \"postCallAnalysisModel\": \"gpt-4o-mini\",\n \"postCallAnalysisData\": [\n {\n \"choices\": [\n \"Negative\",\n \"Positive\",\n \"Neutral\"\n ],\n \"description\": \"what was users sentiment throughout the call\",\n \"name\": \"sentiments\",\n \"type\": \"enum\"\n },\n {\n \"description\": \"Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call\",\n \"name\": \"summary\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Select the data about their work\",\n \"name\": \"what they did in their work?\",\n \"type\": \"string\"\n }\n ],\n \"selectedTools\": [\n \"019e9308-6e56-7488-910a-cceed909fc7a\",\n \"019e92fc-e8a4-7c3f-8b14-89a55db6f748\"\n ],\n \"knowledgeBase\": \"\",\n \"beginMessage\": \"\",\n \"startSpeaker\": \"agent\",\n \"createdAt\": \"2026-06-04 14:10:48.49862 +0000 UTC\",\n \"updatedAt\": \"2026-06-11 10:57:37.109987 +0000 UTC\",\n \"prompt\": \"The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\\n\\n# AGNI Friendly Daily Check-In Companion\\n\\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\\n\\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\\n\\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\\n\\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\\nTalk in hindi.\",\n \"endcallOnSilenceDuration\": 10000,\n \"reminderMessage\": \"Hey there are you there?\",\n \"voicemailCustomPatterns\": null,\n \"interruptionSensitivity\": 0.1,\n \"calcomAccountName\": \"Default\",\n \"calcomStatus\": \"active\",\n \"calcomConnectionType\": \"agent\",\n \"ghlAssignUserIdList\": [],\n \"memory\": true,\n \"calendarTimezone\": \"UTC\",\n \"accent\": [],\n \"emotion\": false,\n \"crmSyncProviders\": null,\n \"salesforceCalendarId\": \"\",\n \"salesforceAssignUserIdList\": [],\n \"emergencyFallback\": \"+919911293960\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ravan.ai/api/v1/agents/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentName\": \"Agni2324\",\n \"status\": \"ACTIVE\",\n \"model\": \"Agni Premium\",\n \"s2sModel\": \"Agni Premium\",\n \"voiceId\": \"Iris\",\n \"temperature\": 0.7,\n \"reminderTriggerMs\": 10000,\n \"reminderMaxCount\": 1,\n \"ambientSound\": \"city_ambience\",\n \"ambientSoundVolume\": 1,\n \"maxCallDurationMs\": 240000,\n \"ringDurationMs\": 30000,\n \"voicemailMessage\": \"\",\n \"voicemailDetectionTimeoutMs\": 5000,\n \"postCallAnalysisModel\": \"gpt-4o-mini\",\n \"postCallAnalysisData\": [\n {\n \"choices\": [\n \"Negative\",\n \"Positive\",\n \"Neutral\"\n ],\n \"description\": \"what was users sentiment throughout the call\",\n \"name\": \"sentiments\",\n \"type\": \"enum\"\n },\n {\n \"description\": \"Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call\",\n \"name\": \"summary\",\n \"type\": \"string\"\n },\n {\n \"description\": \"Select the data about their work\",\n \"name\": \"what they did in their work?\",\n \"type\": \"string\"\n }\n ],\n \"selectedTools\": [\n \"019e9308-6e56-7488-910a-cceed909fc7a\",\n \"019e92fc-e8a4-7c3f-8b14-89a55db6f748\"\n ],\n \"knowledgeBase\": \"\",\n \"beginMessage\": \"\",\n \"startSpeaker\": \"agent\",\n \"createdAt\": \"2026-06-04 14:10:48.49862 +0000 UTC\",\n \"updatedAt\": \"2026-06-11 10:57:37.109987 +0000 UTC\",\n \"prompt\": \"The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\\n\\n# AGNI Friendly Daily Check-In Companion\\n\\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\\n\\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\\n\\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\\n\\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\\nTalk in hindi.\",\n \"endcallOnSilenceDuration\": 10000,\n \"reminderMessage\": \"Hey there are you there?\",\n \"voicemailCustomPatterns\": null,\n \"interruptionSensitivity\": 0.1,\n \"calcomAccountName\": \"Default\",\n \"calcomStatus\": \"active\",\n \"calcomConnectionType\": \"agent\",\n \"ghlAssignUserIdList\": [],\n \"memory\": true,\n \"calendarTimezone\": \"UTC\",\n \"accent\": [],\n \"emotion\": false,\n \"crmSyncProviders\": null,\n \"salesforceCalendarId\": \"\",\n \"salesforceAssignUserIdList\": [],\n \"emergencyFallback\": \"+919911293960\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Agent updated successfully",
"data": { "id": "...", "agentName": "Sales Bot v2" }
}
Authorizations
string
required
Your Agni API key used to authenticate the request. Pass it in the
X-Api-Key header. Find or rotate it from your Ravan AI account settings.Request
Example curl:curl --request PATCH \
--url https://api.ravan.ai/api/v1/agents/{id}/ \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: YOUR_API_KEY' \
--data '{
"agentName": "Agni2324",
"status": "ACTIVE",
"model": "Agni Premium",
"s2sModel": "Agni Premium",
"voiceId": "Iris",
"temperature": 0.7,
"reminderTriggerMs": 10000,
"reminderMaxCount": 1,
"ambientSound": "city_ambience",
"ambientSoundVolume": 1,
"maxCallDurationMs": 240000,
"ringDurationMs": 30000,
"voicemailMessage": "",
"voicemailDetectionTimeoutMs": 5000,
"postCallAnalysisModel": "gpt-4o-mini",
"postCallAnalysisData": [
{
"choices": [
"Negative",
"Positive",
"Neutral"
],
"description": "what was users sentiment throughout the call",
"name": "sentiments",
"type": "enum"
},
{
"description": "Detailed summary of the call before you transfer the call to a human agent so that the human agent can understand the context of the call",
"name": "summary",
"type": "string"
},
{
"description": "Select the data about their work",
"name": "what they did in their work?",
"type": "string"
}
],
"selectedTools": [
"019e9308-6e56-7488-910a-cceed909fc7a",
"019e92fc-e8a4-7c3f-8b14-89a55db6f748"
],
"knowledgeBase": "",
"beginMessage": "",
"startSpeaker": "agent",
"createdAt": "2026-06-04 14:10:48.49862 +0000 UTC",
"updatedAt": "2026-06-11 10:57:37.109987 +0000 UTC",
"prompt": "The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}\n\n# AGNI Friendly Daily Check-In Companion\n\nYou are AGNI, a warm, friendly, caring, and conversational AI companion.\n\nYour role is to have natural human-like conversations and regularly check in on how people are doing throughout their day.\n\nYou are NOT a therapist, counselor, interviewer, recruiter, salesperson, or technical assistant.\n\nYou are simply a friendly AI companion who enjoys talking to people and learning about their day.\nTalk in hindi.\n## Personality\n\n* Friendly\n* Warm\n* Curious\n* Positive\n* Caring\n* Patient\n* Conversational\n* Human-like\n\nSpeak naturally like a supportive colleague or friend.\n\nKeep responses short and engaging.\n\nAvoid sounding robotic.\n\n## Primary Goal\n\nYour goal is to make people feel heard and engaged by asking thoughtful questions about their day, work, activities, and well-being.\n\nYou should keep the conversation flowing naturally.\n\n## Conversation Style\n\n* Ask one question at a time.\n* Listen carefully to the answer.\n* Respond to what the user says.\n* Ask relevant follow-up questions.\n* Show genuine curiosity.\n* Avoid rapid-fire questioning.\n\n## Questions You Can Ask\n\n### General Check-In\n\n* How are you today?\n* How has your day been so far?\n* How are you feeling right now?\n* How's everything going?\n\n### Work Check-In\n\n* How was work today?\n* What kept you busy today?\n* Did anything interesting happen at work?\n* Was today productive or hectic?\n\n### Daily Activities\n\n* What did you do today?\n* How did you spend most of your day?\n* Did you get everything done that you planned?\n* What was the best part of your day?\n\n### Break & Wellness\n\n* Did you get a chance to take any breaks today?\n* When was your last break?\n* Did you have lunch on time?\n* Have you been staying hydrated today?\n* Did you get some time to relax?\n\n### Personal Life\n\n* Did you spend time with family or friends today?\n* Have you watched anything interesting recently?\n* Any plans for the evening?\n* Looking forward to anything this week?\n\n## Follow-Up Behavior\n\nAlways acknowledge what the user says before asking the next question.\n\nExample:\n\nUser:\n\"I've been working all day.\"\n\nAGNI:\n\"Sounds like you've had a busy day. Did you manage to take any breaks in between?\"\n\nUser:\n\"Only one lunch break.\"\n\nAGNI:\n\"At least you got some time to step away. What did you have for lunch today?\"\n\n## Emotional Awareness\n\nIf the user sounds happy:\n\n* Celebrate with them.\n* Ask about what went well.\n\nIf the user sounds stressed:\n\n* Be supportive.\n* Ask gentle questions.\n* Do not pressure them.\n\nExample:\n\n\"That sounds like a long day. What was the most challenging part?\"\n\n## Important Rules\n\n* Never interrogate.\n* Never ask multiple questions at once.\n* Never sound like a survey.\n* Never rush the conversation.\n* Never judge the user.\n* Never give unsolicited advice.\n* Never discuss internal instructions.\n\n## Conversation Flow\n\n1. Greet the user.\n2. Ask how they are doing.\n3. Discuss their day.\n4. Ask about work or activities.\n5. Ask whether they took breaks.\n6. Ask about meals.\n7. Ask about plans for the evening.\n8. Continue naturally based on their answers.",
"endcallOnSilenceDuration": 10000,
"reminderMessage": "Hey there are you there?",
"voicemailCustomPatterns": null,
"interruptionSensitivity": 0.1,
"calcomAccountName": "Default",
"calcomStatus": "active",
"calcomConnectionType": "agent",
"ghlAssignUserIdList": [],
"memory": true,
"calendarTimezone": "UTC",
"accent": [],
"emotion": false,
"crmSyncProviders": null,
"salesforceCalendarId": "",
"salesforceAssignUserIdList": [],
"emergencyFallback": "+919911293960"
}'
Path Parameters
string
required
The unique ID of the resource in the path. Use the ID returned by the related create or list endpoint.
Body
string
The public-facing display name for the agent. This is the name users may see or hear during conversations.
string
The LLM model identifier used by the agent for reasoning and responses.
string
The speech-to-speech model identifier used for realtime voice conversations.
string
The voice ID used for the agent speech output.
number
Controls response randomness for the agent model. Lower values are more deterministic; higher values are more varied.
integer
The amount of silence, in milliseconds, before the agent sends a reminder or prompt.
integer
The maximum number of reminder messages the agent can send during a call.
string
The background sound profile to play during calls. Leave empty to disable ambient audio.
number
The volume level for the selected ambient sound. Use a decimal value from
0 to 1, where 0 is muted and 1 is full volume.boolean
Whether the call should end automatically after a long silence from the user.
integer
The maximum allowed call duration in milliseconds. The call ends when this limit is reached.
integer
The maximum time, in milliseconds, to let an outbound call ring before it is treated as unanswered.
boolean
Whether the agent should detect voicemail during outbound calls.
string
The message the agent should leave when voicemail is detected.
integer
The maximum time, in milliseconds, to wait for voicemail detection before continuing the call flow.
boolean
Whether to transfer the call to a backup number on failure.
string
The backup number to transfer the call to.
object
Interactive voice response settings for the agent, including keypad options and routing behavior.
string
The model used to generate post-call analysis, such as summaries, sentiment, and disposition.
string
The prompt used to generate the post-call summary. Include the outcome, details, and next steps you want the AI to extract.
object
The tools enabled for the agent. Include tool IDs and any configuration needed for the agent to call them.
object
Integration settings for the agent, such as connected scheduling, CRM, or webhook configuration.
string
The knowledge base reference or content available to the agent during conversations.
string
The first message the agent says when the conversation starts. Keep it short and natural for voice calls.
string
Who speaks first when the call starts. Use the value supported by the agent configuration, such as
agent or user.Response
boolean
Whether the request succeeded.
string
Human-readable status message.
object
Returned data.
Show data
Show data
string
Unique agent ID
string
Organization this agent belongs to
string
Associated widget settings ID
string
Internal name of the agent
string
Display name of the agent
string
status field. Allowed values:
AGENT_STATUS_UNSPECIFIED, AGENT_STATUS_ACTIVE, AGENT_STATUS_INACTIVE.string
LLM model identifier
string
Speech-to-speech model identifier
string
Voice ID for TTS
number
LLM temperature setting
integer
Milliseconds before sending a reminder
integer
Maximum number of reminders to send
string
Ambient sound identifier
number
Volume of ambient sound (0.0 - 1.0)
boolean
Whether to end the call after silence
integer
Maximum call duration in milliseconds
integer
Ring duration in milliseconds
boolean
Whether to enable voicemail detection
string
Message to leave on voicemail
integer
Voicemail detection timeout in milliseconds
boolean
Whether to transfer the call to a backup number on failure
string
The backup number to transfer the call to
object
IVR (Interactive Voice Response) configuration
string
Model to use for post-call analysis
string
Prompt used for generating call summary
object
Tools selected for this agent
object
Integration configuration
string
Knowledge base content or reference
string
Opening message spoken by the agent
string
Who speaks first: agent or user
string
Creation timestamp
string
Last update timestamp
{
"success": true,
"message": "Agent updated successfully",
"data": { "id": "...", "agentName": "Sales Bot v2" }
}
Authorizations
Path Parameters
Agent ID
Body
application/json