Skip to main content
GET
/
api
/
v1
/
agents
/
List Agents
curl --request GET \
  --url https://api.ravan.ai/api/v1/agents/ \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "message": "Agents fetched successfully",
  "data": [
    {
      "id": "019eb654-a178-77c6-9555-1d33d8520881b",
      "organizationId": "95a4e899-03a7-4f1b-834d-87043386e8e59",
      "agentName": "Input field",
      "status": "ACTIVE",
      "model": "Agni Premium",
      "voiceId": "Iris",
      "temperature": 0.7,
      "reminderTriggerMs": 10000,
      "maxCallDurationMs": 600000,
      "webhookUrls": ["https://webhook.site/example"],
      "callStats": { "totalCalls": 3, "noAnswerCalls": 3 },
      "calendarTimezone": "Asia/Calcutta",
      "emotion": true,
      "emergencyFallback": "+1-555-0100"
    },
    {
      "id": "019e92f8-f032-7fb7-b294-508f4167618e",
      "organizationId": "95a4e479-03a7-4f1b-834d-8705756e8e59",
      "agentName": "Agni",
      "status": "ACTIVE",
      "model": "Agni Premium",
      "voiceId": "Iris",
      "temperature": 0.7,
      "reminderTriggerMs": 10000,
      "maxCallDurationMs": 240000,
      "webhookUrls": ["https://orgfarm.example/webhook"],
      "callStats": { "totalCalls": 19, "completedCalls": 18 },
      "calendarTimezone": "UTC",
      "emotion": false,
      "emergencyFallback": "+1-555-0100"
    }
  ],
  "meta": { "total": "2", "limit": 10, "offset": 0 }
}

Request

Example curl:
curl -X GET "{{base_url}}agents/?limit=10&offset=0" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
Example PowerShell:
Invoke-WebRequest -Uri "{{base_url}}agents/?limit=10&offset=0" -Method GET -Headers @{"X-Api-Key"="YOUR_API_KEY"} | Select-Object -Expand Content

{
  "success": true,
  "message": "Agents fetched successfully",
  "data": [
    {
      "id": "019eb654-a178-77c6-9555-1d33d8520881b",
      "organizationId": "95a4e899-03a7-4f1b-834d-87043386e8e59",
      "agentName": "Input field",
      "status": "ACTIVE",
      "model": "Agni Premium",
      "voiceId": "Iris",
      "temperature": 0.7,
      "reminderTriggerMs": 10000,
      "maxCallDurationMs": 600000,
      "webhookUrls": ["https://webhook.site/example"],
      "callStats": { "totalCalls": 3, "noAnswerCalls": 3 },
      "calendarTimezone": "Asia/Calcutta",
      "emotion": true,
      "emergencyFallback": "+1-555-0100"
    },
    {
      "id": "019e92f8-f032-7fb7-b294-508f4167618e",
      "organizationId": "95a4e479-03a7-4f1b-834d-8705756e8e59",
      "agentName": "Agni",
      "status": "ACTIVE",
      "model": "Agni Premium",
      "voiceId": "Iris",
      "temperature": 0.7,
      "reminderTriggerMs": 10000,
      "maxCallDurationMs": 240000,
      "webhookUrls": ["https://orgfarm.example/webhook"],
      "callStats": { "totalCalls": 19, "completedCalls": 18 },
      "calendarTimezone": "UTC",
      "emotion": false,
      "emergencyFallback": "+1-555-0100"
    }
  ],
  "meta": { "total": "2", "limit": 10, "offset": 0 }
}

Authorizations

X-Api-Key
string
header
required

Query Parameters

limit
integer<int32>

Number of results to return

offset
integer<int32>

Pagination offset

Response

200 - application/json

Successful response

success
boolean
message
string
data
object[]
meta
object