PATCH
/
api
/
v1
/
agents
/
{id}
curl -X PATCH https://api.ravan.ai/api/v1/agents/019d1fdb-98e9-7c87-86c7-321e2fa98733/ \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Sales Assistant",
    "temperature": 0.5,
    "begin_message": "Hi there! How can I assist you today?"
  }'

{
  "success": true,
  "message": "Agent updated successfully",
  "data": {
    "id": "019d1fdb-98e9-7c87-86c7-321e2fa98733",
    "organization_id": "1268c1f0-19f3-47db-aefb-c16a7c3ace6e",
    "name": "Updated Sales Assistant",
    "agent_name": "Ava",
    "status": "AGENT_STATUS_ACTIVE",
    "model": "gpt-4o",
    "temperature": 0.5,
    "selected_tools": [],
    "integrations": null,
    "begin_message": "Hi there! How can I assist you today?",
    "start_speaker": "agent",
    "created_at": "2026-03-20T10:30:00Z",
    "updated_at": "2026-03-20T15:45:00Z"
  }
}
This is a partial update (PATCH). Only include the fields you want to change in the request body.

​
Authorizations

​
X-Api-Key
string
required
Your Agni API key. Find it in your support@ravan.ai under Settings → API Keys.

​
Path Parameters

​
id
string
required
The unique UUID of the agent to update.

​
Body

​
widget_settings_id
string
UUID of the widget settings to associate.
​
name
string
Internal name for the agent.
​
agent_name
string
Display name shown to end users.
​
model
string
LLM model identifier (e.g. gpt-4o, gpt-4o-mini).
​
s2s_model
string
Speech-to-speech model identifier.
​
voice_id
string
Voice profile ID for text-to-speech.
​
temperature
number
LLM temperature (0.0–1.0).
​
reminder_trigger_ms
integer
Milliseconds of silence before sending a reminder.
​
reminder_max_count
integer
Maximum reminders per call.
​
ambient_sound
string
Ambient sound identifier.
​
ambient_sound_volume
number
Ambient sound volume (0.0–1.0).
​
end_call_after_silence
boolean
Whether to end the call after prolonged silence.
​
max_call_duration_ms
integer
Maximum call duration in milliseconds.
​
ring_duration_ms
integer
Ring duration in milliseconds.
​
enable_voicemail_detection
boolean
Enable or disable 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 for post-call analysis.
​
analysis_summary_prompt
string
Prompt for post-call summary generation.
​
selected_tools
object
Tool IDs enabled for this agent.
​
integrations
object
Integration configuration.
​
knowledge_base
string
Knowledge base content or reference.
​
begin_message
string
Opening greeting message.
​
start_speaker
string
Who speaks first: "agent" or "user".

​
Response

​
success
boolean
Whether the request succeeded.
​
message
string
Human-readable status message.
​
data
object
The updated agent object with all fields.
curl -X PATCH https://api.ravan.ai/api/v1/agents/019d1fdb-98e9-7c87-86c7-321e2fa98733/ \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Sales Assistant",
    "temperature": 0.5,
    "begin_message": "Hi there! How can I assist you today?"
  }'

{
  "success": true,
  "message": "Agent updated successfully",
  "data": {
    "id": "019d1fdb-98e9-7c87-86c7-321e2fa98733",
    "organization_id": "1268c1f0-19f3-47db-aefb-c16a7c3ace6e",
    "name": "Updated Sales Assistant",
    "agent_name": "Ava",
    "status": "AGENT_STATUS_ACTIVE",
    "model": "gpt-4o",
    "temperature": 0.5,
    "selected_tools": [],
    "integrations": null,
    "begin_message": "Hi there! How can I assist you today?",
    "start_speaker": "agent",
    "created_at": "2026-03-20T10:30:00Z",
    "updated_at": "2026-03-20T15:45: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

Successful response

​
success
boolean
​
message
string
​
data
object