> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ravan.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Agent

> Get Agent.

### Request

Example curl (replace `{id}` and `<api-key>`):

```bash theme={null}
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):

```powershell theme={null}
Invoke-RestMethod -Method Get -Uri "https://api.ravan.ai/api/v1/agents/{id}/" -Headers @{ "X-Api-Key" = "<api-key>" }
```

### Authorizations

<ParamField header="X-Api-Key" type="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.
</ParamField>

***

### Path Parameters

<ParamField path="id" type="string" required>
  The unique ID of the resource in the path. Use the ID returned by the related create or list endpoint.
</ParamField>

***

### Response

<ResponseField name="success" type="boolean">
  Whether the request succeeded.
</ResponseField>

<ResponseField name="message" type="string">
  Human-readable status message.
</ResponseField>

<ResponseField name="data" type="object">
  Returned data.

  <Expandable title="data">
    <ResponseField name="id" type="string">Unique agent ID</ResponseField>
    <ResponseField name="organizationId" type="string">Organization this agent belongs to</ResponseField>
    <ResponseField name="agentName" type="string">Display name of the agent</ResponseField>
    <ResponseField name="status" type="string">Agent status</ResponseField>
    <ResponseField name="model" type="string">LLM model identifier</ResponseField>
    <ResponseField name="s2sModel" type="string">Speech-to-speech model identifier</ResponseField>
    <ResponseField name="voiceId" type="string">Voice ID for TTS</ResponseField>
    <ResponseField name="temperature" type="number">LLM temperature setting</ResponseField>
    <ResponseField name="reminderTriggerMs" type="integer">Milliseconds before sending a reminder</ResponseField>
    <ResponseField name="reminderMaxCount" type="integer">Maximum number of reminders to send</ResponseField>
    <ResponseField name="ambientSound" type="string">Ambient sound identifier</ResponseField>
    <ResponseField name="ambientSoundVolume" type="number">Volume of ambient sound (0.0 - 1.0)</ResponseField>
    <ResponseField name="maxCallDurationMs" type="integer">Maximum call duration in milliseconds</ResponseField>
    <ResponseField name="ringDurationMs" type="integer">Ring duration in milliseconds</ResponseField>
    <ResponseField name="voicemailMessage" type="string">Message to leave on voicemail</ResponseField>
    <ResponseField name="voicemailDetectionTimeoutMs" type="integer">Voicemail detection timeout in milliseconds</ResponseField>
    <ResponseField name="postCallAnalysisModel" type="string">Model to use for post-call analysis</ResponseField>
    <ResponseField name="postCallAnalysisData" type="array">Array of analysis field descriptors</ResponseField>
    <ResponseField name="selectedTools" type="object">Tools selected for this agent (may be null)</ResponseField>
    <ResponseField name="knowledgeBase" type="string">Knowledge base reference</ResponseField>
    <ResponseField name="beginMessage" type="string">Opening message spoken by the agent</ResponseField>
    <ResponseField name="startSpeaker" type="string">Who speaks first: agent or user</ResponseField>
    <ResponseField name="createdAt" type="string">Creation timestamp</ResponseField>
    <ResponseField name="updatedAt" type="string">Last update timestamp</ResponseField>
    <ResponseField name="webhookUrls" type="string[]">List of webhook URLs</ResponseField>
    <ResponseField name="ghlCalendarId" type="string">GHL calendar ID</ResponseField>
    <ResponseField name="calcomCalendarId" type="string">Cal.com calendar ID</ResponseField>
    <ResponseField name="prompt" type="string">Agent prompt template</ResponseField>
    <ResponseField name="endcallOnSilenceDuration" type="integer">Milliseconds of silence before ending call</ResponseField>
    <ResponseField name="reminderMessage" type="string">Reminder message text</ResponseField>
    <ResponseField name="voicemailCustomPatterns" type="object">Custom voicemail detection patterns</ResponseField>
    <ResponseField name="interruptionSensitivity" type="number">Interruption sensitivity threshold</ResponseField>
    <ResponseField name="calcomApiKey" type="string">Cal.com API key (masked in examples)</ResponseField>
    <ResponseField name="calcomApiUrl" type="string">Cal.com API URL</ResponseField>
    <ResponseField name="calcomAccountName" type="string">Cal.com account name</ResponseField>
    <ResponseField name="calcomStatus" type="string">Cal.com connection status</ResponseField>
    <ResponseField name="calcomConnectionType" type="string">Cal.com connection type</ResponseField>
    <ResponseField name="ghlAssignUserIdList" type="string[]">Assigned GHL user IDs</ResponseField>
    <ResponseField name="memory" type="boolean">Whether agent memory is enabled</ResponseField>
    <ResponseField name="calendarTimezone" type="string">Agent calendar timezone</ResponseField>
    <ResponseField name="accent" type="string[]">List of accents</ResponseField>
    <ResponseField name="emotion" type="boolean">Whether emotion is enabled</ResponseField>
    <ResponseField name="crmSyncProviders" type="object">CRM sync provider flags</ResponseField>
    <ResponseField name="salesforceCalendarId" type="string">Salesforce calendar ID</ResponseField>
    <ResponseField name="salesforceAssignUserIdList" type="string[]">Salesforce assigned user IDs</ResponseField>
    <ResponseField name="emergencyFallback" type="string">Emergency fallback phone number</ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  {
    "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"
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /api/v1/agents/{id}/
openapi: 3.0.1
info:
  title: Agni API
  version: 1.0.0
  description: >-
    Agni API for managing agents, tools, widget settings, telephony, and
    integrations.
servers:
  - url: https://api.ravan.ai
security:
  - X-Api-Key: []
tags:
  - name: AgentService
  - name: AgentToolService
  - name: WidgetSettingsService
  - name: PhoneService
  - name: AppointmentService
  - name: GHLService
  - name: CalComService
  - name: CampaignService
  - name: ContactService
  - name: CallingService
  - name: RAGService
  - name: ModelService
  - name: HealthService
paths:
  /api/v1/agents/{id}/:
    get:
      tags:
        - AgentService
      summary: Get Agent
      operationId: GetAgent
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Agent ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAgentResponse'
components:
  schemas:
    GetAgentResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          $ref: '#/components/schemas/Agent'
    Agent:
      type: object
      properties:
        id:
          type: string
          description: Unique agent ID
        organization_id:
          type: string
          description: Organization this agent belongs to
        widget_settings_id:
          type: string
          description: Associated widget settings ID
        name:
          type: string
          description: Internal name of the agent
        agent_name:
          type: string
          description: Display name of the agent
        status:
          $ref: '#/components/schemas/AgentStatus'
        model:
          type: string
          description: LLM model identifier
        s2s_model:
          type: string
          description: Speech-to-speech model identifier
        voice_id:
          type: string
          description: Voice ID for TTS
        temperature:
          type: number
          format: double
          description: LLM temperature setting
        reminder_trigger_ms:
          type: integer
          format: int32
          description: Milliseconds before sending a reminder
        reminder_max_count:
          type: integer
          format: int32
          description: Maximum number of reminders to send
        ambient_sound:
          type: string
          description: Ambient sound identifier
        ambient_sound_volume:
          type: number
          format: double
          description: Volume of ambient sound (0.0 - 1.0)
        end_call_after_silence:
          type: boolean
          description: Whether to end the call after silence
        max_call_duration_ms:
          type: integer
          format: int32
          description: Maximum call duration in milliseconds
        ring_duration_ms:
          type: integer
          format: int32
          description: Ring duration in milliseconds
        enable_voicemail_detection:
          type: boolean
          description: Whether to enable voicemail detection
        voicemail_message:
          type: string
          description: Message to leave on voicemail
        voicemail_detection_timeout_ms:
          type: integer
          format: int32
          description: Voicemail detection timeout in milliseconds
        enable_emergency_fallback:
          type: boolean
          description: Whether to transfer the call to a backup number on failure
        emergency_fallback_number:
          type: string
          description: The backup number to transfer the call to
        ivr_options:
          type: object
          description: IVR (Interactive Voice Response) configuration
        post_call_analysis_model:
          type: string
          description: Model to use for post-call analysis
        analysis_summary_prompt:
          type: string
          description: Prompt used for generating call summary
        selected_tools:
          type: object
          description: Tools selected for this agent
        integrations:
          type: object
          description: Integration configuration
        knowledge_base:
          type: string
          description: Knowledge base content or reference
        begin_message:
          type: string
          description: Opening message spoken by the agent
        start_speaker:
          type: string
          description: 'Who speaks first: agent or user'
        created_at:
          type: string
          description: Creation timestamp
        updated_at:
          type: string
          description: Last update timestamp
    AgentStatus:
      type: string
      enum:
        - AGENT_STATUS_UNSPECIFIED
        - AGENT_STATUS_ACTIVE
        - AGENT_STATUS_INACTIVE
      description: Status of the agent
  securitySchemes:
    X-Api-Key:
      type: apiKey
      in: header
      name: X-Api-Key

````