Get Agent

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

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.ravan.ai/api/v1/agents/{id}/', 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/{id}/",
  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/{id}/"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.ravan.ai/api/v1/agents/{id}/")

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": "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"
  }
}

GET

api

agents

{id}

Get Agent

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

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.ravan.ai/api/v1/agents/{id}/', 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/{id}/",
  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/{id}/"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.ravan.ai/api/v1/agents/{id}/")

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

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

string

required

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

Response

boolean

Whether the request succeeded.

string

Human-readable status message.

object

Returned data.

Show data

string

Unique agent ID

string

Organization this agent belongs to

string

Display name of the agent

string

Agent status

string

LLM model identifier

string

Speech-to-speech model identifier

string

Voice ID for TTS

number

LLM temperature setting

integer

Milliseconds before sending a reminder

integer

Maximum number of reminders to send

string

Ambient sound identifier

number

Volume of ambient sound (0.0 - 1.0)

integer

Maximum call duration in milliseconds

integer

Ring duration in milliseconds

string

Message to leave on voicemail

integer

Voicemail detection timeout in milliseconds

string

Model to use for post-call analysis

array

Array of analysis field descriptors

object

Tools selected for this agent (may be null)

string

Knowledge base reference

string

Opening message spoken by the agent

string

Who speaks first: agent or user

string

Creation timestamp

string

Last update timestamp

string[]

List of webhook URLs

string

GHL calendar ID

string

Cal.com calendar ID

string

Agent prompt template

integer

Milliseconds of silence before ending call

string

Reminder message text

object

Custom voicemail detection patterns

number

Interruption sensitivity threshold

string

Cal.com API key (masked in examples)

string

Cal.com API URL

string

Cal.com account name

string

Cal.com connection status

string

Cal.com connection type

string[]

Assigned GHL user IDs

boolean

Whether agent memory is enabled

string

Agent calendar timezone

string[]

List of accents

boolean

Whether emotion is enabled

object

CRM sync provider flags

string

Salesforce calendar ID

string[]

Salesforce assigned user IDs

string

Emergency fallback phone number

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

string

required

Agent ID

Response

200 - application/json

Successful response

success

boolean

message

string

data

object

Show child attributes

Introduction

Agent API

Organization API

Agent Tool API

Phone Number & Telephony API

Campaign API

Contact API

Calling API

Appointment API

GHL Integration API

Cal.com Integration API

RAG Knowledge Base API

Webhooks

Health API

Get Agent

Request

Authorizations

Path Parameters

Response

Authorizations

Path Parameters

Response

​Request

​Authorizations

​Path Parameters

​Response

Authorizations

Path Parameters

Response

Request

Authorizations

Path Parameters

Response