Get Agent

Get Agent.

GET /api/v1/agents/{id}

Get Agent

cURL

curl --request GET \
  --url https://api.ravan.ai/api/v1/agents/{id}/ \
  --header 'X-Api-Key: <api-key>'

200

{
  "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

---

Response

success · boolean

Whether the request succeeded.

message · string

Human-readable status message.

data · object

Returned data.

Show data

id · string

Unique agent ID

organization_id · string

Organization this agent belongs to

widget_settings_id · string

Associated widget settings ID

name · string

Internal name of the agent

agent_name · string

Display name of the agent

status · string

status field. Allowed values: AGENT_STATUS_UNSPECIFIED, AGENT_STATUS_ACTIVE, AGENT_STATUS_INACTIVE.

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 to send

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

Whether to 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 (Interactive Voice Response) configuration

post_call_analysis_model · string

Model to use for post-call analysis

analysis_summary_prompt · string

Prompt used for generating call summary

selected_tools · object

Tools selected 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

created_at · string

Creation timestamp

updated_at · string

Last update timestamp

200

{
  "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

Response

200 - application/json

Successful response

success · boolean

message · string

data · object

Show child attributes