Skip to main content
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 '
{
  "widget_settings_id": "<string>",
  "name": "<string>",
  "agent_name": "<string>",
  "model": "<string>",
  "s2s_model": "<string>",
  "voice_id": "<string>",
  "temperature": 123,
  "reminder_trigger_ms": 123,
  "reminder_max_count": 123,
  "ambient_sound": "<string>",
  "ambient_sound_volume": 123,
  "end_call_after_silence": true,
  "max_call_duration_ms": 123,
  "ring_duration_ms": 123,
  "enable_voicemail_detection": true,
  "voicemail_message": "<string>",
  "voicemail_detection_timeout_ms": 123,
  "ivr_options": {},
  "post_call_analysis_model": "<string>",
  "analysis_summary_prompt": "<string>",
  "selected_tools": {},
  "integrations": {},
  "knowledge_base": "<string>",
  "begin_message": "<string>",
  "start_speaker": "<string>"
}
'
{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "id": "id_123",
    "organization_id": "organization_123",
    "widget_settings_id": "widget_settings_123",
    "name": "Support Bot",
    "agent_name": "Support Bot",
    "status": "AGENT_STATUS_ACTIVE",
    "model": "gpt-4o",
    "s2s_model": "gpt-4o",
    "voice_id": "voice_123",
    "temperature": 0.7,
    "reminder_trigger_ms": 5000,
    "reminder_max_count": 1,
    "ambient_sound": "example",
    "ambient_sound_volume": 0.3,
    "end_call_after_silence": true,
    "max_call_duration_ms": 5000,
    "ring_duration_ms": 5000,
    "enable_voicemail_detection": true,
    "voicemail_message": "en-US-female-1",
    "voicemail_detection_timeout_ms": 5000,
    "ivr_options": {},
    "post_call_analysis_model": "gpt-4o",
    "analysis_summary_prompt": "example",
    "selected_tools": {},
    "integrations": {},
    "knowledge_base": "example",
    "begin_message": "Request completed successfully",
    "start_speaker": "example",
    "created_at": "2026-03-14T12:00:00Z",
    "updated_at": "2026-03-14T12:00:00Z"
  }
}

​
Authorizations

​
X-Api-Key
string
required
Your Agni API key. Find it in your RavanAi.

​
Path Parameters

​
id
string
required
Agent ID

​
Body

​
widget_settings_id
string
Associated widget settings ID
​
name
string
Internal name of the agent
​
agent_name
string
Display name of the agent
​
model
string
LLM model identifier
​
s2s_model
string
Speech-to-speech model identifier
​
voice_id
string
Voice ID for TTS
​
temperature
number
LLM temperature setting
​
reminder_trigger_ms
integer
Milliseconds before sending a reminder
​
reminder_max_count
integer
Maximum number of reminders
​
ambient_sound
string
Ambient sound identifier
​
ambient_sound_volume
number
Volume of ambient sound (0.0 - 1.0)
​
end_call_after_silence
boolean
Whether to end the call after silence
​
max_call_duration_ms
integer
Maximum call duration in milliseconds
​
ring_duration_ms
integer
Ring duration in milliseconds
​
enable_voicemail_detection
boolean
Enable voicemail detection
​
voicemail_message
string
Message to leave on voicemail
​
voicemail_detection_timeout_ms
integer
Voicemail detection timeout in milliseconds
​
ivr_options
object
IVR configuration
​
post_call_analysis_model
string
Model to use for post-call analysis
​
analysis_summary_prompt
string
Prompt for generating call summary
​
selected_tools
object
Tools enabled for this agent
​
integrations
object
Integration configuration
​
knowledge_base
string
Knowledge base content or reference
​
begin_message
string
Opening message spoken by the agent
​
start_speaker
string
Who speaks first: agent or user

​
Response

​
success
boolean
Whether the request succeeded.
​
message
string
Human-readable status message.
​
data
object
Returned data.
{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "id": "id_123",
    "organization_id": "organization_123",
    "widget_settings_id": "widget_settings_123",
    "name": "Support Bot",
    "agent_name": "Support Bot",
    "status": "AGENT_STATUS_ACTIVE",
    "model": "gpt-4o",
    "s2s_model": "gpt-4o",
    "voice_id": "voice_123",
    "temperature": 0.7,
    "reminder_trigger_ms": 5000,
    "reminder_max_count": 1,
    "ambient_sound": "example",
    "ambient_sound_volume": 0.3,
    "end_call_after_silence": true,
    "max_call_duration_ms": 5000,
    "ring_duration_ms": 5000,
    "enable_voicemail_detection": true,
    "voicemail_message": "en-US-female-1",
    "voicemail_detection_timeout_ms": 5000,
    "ivr_options": {},
    "post_call_analysis_model": "gpt-4o",
    "analysis_summary_prompt": "example",
    "selected_tools": {},
    "integrations": {},
    "knowledge_base": "example",
    "begin_message": "Request completed successfully",
    "start_speaker": "example",
    "created_at": "2026-03-14T12:00:00Z",
    "updated_at": "2026-03-14T12:00:00Z"
  }
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
string
required

Agent ID

Body

application/json
​
widget_settings_id
string
​
name
string
​
agent_name
string
​
model
string
​
s2s_model
string
​
voice_id
string
​
temperature
number<double>
​
reminder_trigger_ms
integer<int32>
​
reminder_max_count
integer<int32>
​
ambient_sound
string
​
ambient_sound_volume
number<double>
​
end_call_after_silence
boolean
​
max_call_duration_ms
integer<int32>
​
ring_duration_ms
integer<int32>
​
enable_voicemail_detection
boolean
​
voicemail_message
string
​
voicemail_detection_timeout_ms
integer<int32>
​
ivr_options
object
​
post_call_analysis_model
string
​
analysis_summary_prompt
string
​
selected_tools
object
​
integrations
object
​
knowledge_base
string
​
begin_message
string
​
start_speaker
string

Response

200 - application/json

Successful response

​
success
boolean
​
message
string
​
data
object