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

# List Agents

> Retrieve a paginated list of all your agents

## Overview

List all agents owned by the API key holder with pagination, search, and filtering by type and category.

## Authentication

<ParamField header="X-API-Key" type="string" required>
  Your eigi.ai API key. Must be prefixed with `vk_`.
</ParamField>

## Query Parameters

<ParamField query="page" type="integer" default="1">
  Page number (minimum: 1).
</ParamField>

<ParamField query="page_size" type="integer" default="10">
  Items per page (minimum: 1, maximum: 100).
</ParamField>

<ParamField query="search" type="string">
  Search in agent name and description.
</ParamField>

<ParamField query="agent_type" type="string">
  Filter by agent type: `INBOUND` or `OUTBOUND`.
</ParamField>

<ParamField query="agent_category" type="string">
  Filter by agent category (e.g., `Customer Service`, `Sales`).
</ParamField>

## Response

<ResponseField name="agents" type="array">
  Array of agent objects — each containing the full agent configuration (id, name, type, STT/LLM/TTS config, prompt, tools, etc.).
</ResponseField>

<ResponseField name="total" type="integer">
  Total number of agents matching the criteria.
</ResponseField>

<ResponseField name="page" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="page_size" type="integer">
  Number of items per page.
</ResponseField>

<ResponseField name="total_pages" type="integer">
  Total number of pages available.
</ResponseField>


## OpenAPI

````yaml GET /v1/public/agents
openapi: 3.0.0
info:
  title: eigi.ai API
  description: REST API for managing AI voice agents and conversations
  version: 1.0.0
  contact:
    email: buddy@eigi.ai
    url: https://eigi.ai
servers:
  - url: https://api.eigi.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /v1/public/agents:
    get:
      tags:
        - Agents
      summary: List Agents
      description: >-
        Retrieve a paginated list of all agents owned by the API key holder.
        Supports filtering by type, category, and search.
      operationId: listAgents
      parameters:
        - name: page
          in: query
          description: Page number
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: page_size
          in: query
          description: 'Items per page (max: 100)'
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 100
        - name: search
          in: query
          description: Search in agent name and description
          schema:
            type: string
        - name: agent_type
          in: query
          description: Filter by agent type
          schema:
            type: string
            enum:
              - INBOUND
              - OUTBOUND
        - name: agent_category
          in: query
          description: Filter by agent category
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved agents
          content:
            application/json:
              schema:
                type: object
                properties:
                  agents:
                    type: array
                    items:
                      $ref: '#/components/schemas/AgentResponse'
                  total:
                    type: integer
                  page:
                    type: integer
                  page_size:
                    type: integer
                  total_pages:
                    type: integer
        '401':
          description: Unauthorized - Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    AgentResponse:
      type: object
      properties:
        id:
          type: string
          description: Agent ID
        agent_name:
          type: string
          description: Agent name
        agent_description:
          type: string
          description: Agent description
        agent_type:
          type: string
          enum:
            - INBOUND
            - OUTBOUND
          description: Agent type
        agent_category:
          type: string
          description: Agent category
        agent_tips:
          type: array
          items:
            type: string
          description: Usage tips
        agent_mobile_number:
          type: array
          items:
            type: string
          description: Associated mobile numbers
        stt:
          type: object
          description: STT configuration
        llm:
          type: object
          description: LLM configuration
        tts:
          type: object
          description: TTS configuration
        sts:
          type: object
          description: STS configuration (if set)
        call_analysis_enabled:
          type: boolean
          description: Whether call analysis is enabled for the agent
        prompt:
          type: object
          description: Prompt reference
          properties:
            prompt_name:
              type: string
            prompt_version:
              type: integer
            prompt_content:
              type: string
        first_message_prompt:
          type: string
          description: Agent's greeting message
        dynamic_variables:
          type: array
          items:
            type: string
          description: Dynamic variables in the prompt
        tools:
          type: object
          description: Configured tools
        widget_config:
          type: object
          description: Widget configuration
        MediaFiles:
          type: array
          items:
            type: object
            properties:
              fileType:
                type: string
              mediaUrl:
                type: string
          description: Media files associated with the agent
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
    Error:
      type: object
      properties:
        detail:
          type: string
          description: Error message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Get your API key from the eigi.ai Dashboard
        under Settings → API Keys.

````