> ## 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.

# List Agents

> List Agents.

### Request

Example curl:

```bash theme={null}
curl -X GET "{{base_url}}agents/?limit=10&offset=0" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

Example PowerShell:

```powershell theme={null}
Invoke-WebRequest -Uri "{{base_url}}agents/?limit=10&offset=0" -Method GET -Headers @{"X-Api-Key"="YOUR_API_KEY"} | Select-Object -Expand Content
```

***

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


## OpenAPI

````yaml GET /api/v1/agents/
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/:
    get:
      tags:
        - AgentService
      summary: List Agents
      operationId: ListAgents
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
          description: Number of results to return
        - name: offset
          in: query
          schema:
            type: integer
            format: int32
          description: Pagination offset
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAgentsResponse'
components:
  schemas:
    ListAgentsResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/Agent'
        meta:
          $ref: '#/components/schemas/Meta'
    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
    Meta:
      type: object
      properties:
        total:
          type: integer
          format: int64
          description: Total number of records
        limit:
          type: integer
          format: int32
          description: Page size limit
        offset:
          type: integer
          format: int32
          description: Pagination offset
    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

````