Skip to main content
GET
/
api
/
v1
/
agents
/
{id}
/
Get Agent
curl --request GET \
  --url https://api.ravan.ai/api/v1/agents/{id}/ \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "message": "Agent fetched successfully",
  "data": {
    "id": "019eb654-a.........",
    "organizationId": "95a4e479-03a7-4f1b-.......",
    "agentName": "Input field",
    "status": "ACTIVE",
    "model": "Agni Premium",
    "s2sModel": "Agni Premium",
    "voiceId": "Iris",
    "temperature": 0.7,
    "reminderTriggerMs": 10000,
    "reminderMaxCount": 2,
    "ambientSound": "forest_ambience",
    "ambientSoundVolume": 1,
    "maxCallDurationMs": 600000,
    "ringDurationMs": 32000,
    "voicemailMessage": "",
    "voicemailDetectionTimeoutMs": 7000,
    "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": "name of the user",
        "name": "name",
        "type": "string"
      },
      {
        "description": "",
        "name": "email",
        "type": "string"
      },
      {
        "description": "",
        "name": "Phone number.",
        "type": "string"
      }
    ],
    "selectedTools": null,
    "knowledgeBase": "8619dc3f-.......",
    "beginMessage": "",
    "startSpeaker": "agent",
    "createdAt": "2026-06-11 10:57:40.229069 +0000 UTC",
    "updatedAt": "2026-06-11 18:26:17.115921 +0000 UTC",
    "webhookUrls": [
      "https://webhook.site/"
    ],
    "ghlCalendarId": "",
    "calcomCalendarId": "",
    "prompt": "The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}",
    "endcallOnSilenceDuration": 10000,
    "reminderMessage": "HI are you there??",
    "voicemailCustomPatterns": null,
    "interruptionSensitivity": 0.1,
    "calcomApiKey": "cal_.....",
    "calcomApiUrl": "https://api.cal.com",
    "calcomAccountName": "Default",
    "calcomStatus": "active",
    "calcomConnectionType": "agent",
    "ghlAssignUserIdList": [],
    "memory": true,
    "calendarTimezone": "Asia/Calcutta",
    "accent": [
      "india/hindi"
    ],
    "emotion": true,
    "crmSyncProviders": {
      "ghl": true
    },
    "salesforceCalendarId": "",
    "salesforceAssignUserIdList": [],
    "emergencyFallback": "+919123456789"
  }
}

​
Request

Example curl (replace {id} and <api-key>): 
curl -s \
  --request GET \
  --url "https://api.ravan.ai/api/v1/agents/{id}/" \
  -H "X-Api-Key: <api-key>" \
  -H "Accept: application/json"
PowerShell (Invoke-RestMethod): 
Invoke-RestMethod -Method Get -Uri "https://api.ravan.ai/api/v1/agents/{id}/" -Headers @{ "X-Api-Key" = "<api-key>" }

​
Authorizations

​
X-Api-Key
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.

​
Path Parameters

​
id
string
required
The unique ID of the resource in the path. Use the ID returned by the related create or list endpoint.

​
Response

​
success
boolean
Whether the request succeeded.
​
message
string
Human-readable status message.
​
data
object
Returned data.
{
  "success": true,
  "message": "Agent fetched successfully",
  "data": {
    "id": "019eb654-a.........",
    "organizationId": "95a4e479-03a7-4f1b-.......",
    "agentName": "Input field",
    "status": "ACTIVE",
    "model": "Agni Premium",
    "s2sModel": "Agni Premium",
    "voiceId": "Iris",
    "temperature": 0.7,
    "reminderTriggerMs": 10000,
    "reminderMaxCount": 2,
    "ambientSound": "forest_ambience",
    "ambientSoundVolume": 1,
    "maxCallDurationMs": 600000,
    "ringDurationMs": 32000,
    "voicemailMessage": "",
    "voicemailDetectionTimeoutMs": 7000,
    "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": "name of the user",
        "name": "name",
        "type": "string"
      },
      {
        "description": "",
        "name": "email",
        "type": "string"
      },
      {
        "description": "",
        "name": "Phone number.",
        "type": "string"
      }
    ],
    "selectedTools": null,
    "knowledgeBase": "8619dc3f-.......",
    "beginMessage": "",
    "startSpeaker": "agent",
    "createdAt": "2026-06-11 10:57:40.229069 +0000 UTC",
    "updatedAt": "2026-06-11 18:26:17.115921 +0000 UTC",
    "webhookUrls": [
      "https://webhook.site/"
    ],
    "ghlCalendarId": "",
    "calcomCalendarId": "",
    "prompt": "The current date and Time in Asia/Calcutta is {{current_time_Asia/Calcutta}}",
    "endcallOnSilenceDuration": 10000,
    "reminderMessage": "HI are you there??",
    "voicemailCustomPatterns": null,
    "interruptionSensitivity": 0.1,
    "calcomApiKey": "cal_.....",
    "calcomApiUrl": "https://api.cal.com",
    "calcomAccountName": "Default",
    "calcomStatus": "active",
    "calcomConnectionType": "agent",
    "ghlAssignUserIdList": [],
    "memory": true,
    "calendarTimezone": "Asia/Calcutta",
    "accent": [
      "india/hindi"
    ],
    "emotion": true,
    "crmSyncProviders": {
      "ghl": true
    },
    "salesforceCalendarId": "",
    "salesforceAssignUserIdList": [],
    "emergencyFallback": "+919123456789"
  }
}

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