Skip to main content
GET
/
v1
/
public
/
agents
List Agents
curl --request GET \
  --url https://api.eigi.ai/v1/public/agents \
  --header 'X-API-Key: <api-key>'
{
  "agents": [
    {
      "id": "<string>",
      "agent_name": "<string>",
      "agent_description": "<string>",
      "agent_type": "INBOUND",
      "agent_category": "<string>",
      "agent_tips": [
        "<string>"
      ],
      "agent_mobile_number": [
        "<string>"
      ],
      "stt": {},
      "llm": {},
      "tts": {},
      "sts": {},
      "prompt": {
        "prompt_name": "<string>",
        "prompt_version": 123,
        "prompt_content": "<string>"
      },
      "first_message_prompt": "<string>",
      "dynamic_variables": [
        "<string>"
      ],
      "tools": {},
      "widget_config": {},
      "MediaFiles": [
        {
          "fileType": "<string>",
          "mediaUrl": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

​
Overview

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

​
Authentication

​
X-API-Key
string
required
Your eigi.ai API key. Must be prefixed with vk_.

​
Query Parameters

​
page
integer
default:"1"
Page number (minimum: 1).
​
page_size
integer
default:"10"
Items per page (minimum: 1, maximum: 100).
​
search
string
Search in agent name and description.
​
agent_type
string
Filter by agent type: INBOUND or OUTBOUND.
​
agent_category
string
Filter by agent category (e.g., Customer Service, Sales).

​
Response

​
agents
array
Array of agent objects — each containing the full agent configuration (id, name, type, STT/LLM/TTS config, prompt, tools, etc.).
​
total
integer
Total number of agents matching the criteria.
​
page
integer
Current page number.
​
page_size
integer
Number of items per page.
​
total_pages
integer
Total number of pages available.

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get your API key from the eigi.ai Dashboard under Settings → API Keys.

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
page_size
integer
default:10

Items per page (max: 100)

Required range: 1 <= x <= 100
​
search
string

Search in agent name and description

​
agent_type
enum<string>

Filter by agent type

Available options:
INBOUND,
OUTBOUND
​
agent_category
string

Filter by agent category

Response

Successfully retrieved agents

​
agents
object[]
​
total
integer
​
page
integer
​
page_size
integer
​
total_pages
integer