List Agents
curl --request GET \
--url https://api.ravan.ai/api/v1/agents/ \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.ravan.ai/api/v1/agents/"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.ravan.ai/api/v1/agents/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ravan.ai/api/v1/agents/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ravan.ai/api/v1/agents/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ravan.ai/api/v1/agents/")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ravan.ai/api/v1/agents/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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 }
}
Agent API
List Agents
List Agents.
GET
/
api
/
v1
/
agents
/
List Agents
curl --request GET \
--url https://api.ravan.ai/api/v1/agents/ \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.ravan.ai/api/v1/agents/"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.ravan.ai/api/v1/agents/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ravan.ai/api/v1/agents/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ravan.ai/api/v1/agents/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ravan.ai/api/v1/agents/")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ravan.ai/api/v1/agents/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
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 }
}
⌘I

