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>'
import requests

url = "https://api.eigi.ai/v1/public/agents"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.eigi.ai/v1/public/agents', 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.eigi.ai/v1/public/agents",
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.eigi.ai/v1/public/agents"

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

}
HttpResponse<String> response = Unirest.get("https://api.eigi.ai/v1/public/agents")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.eigi.ai/v1/public/agents")

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
{
  "agents": [
    {
      "id": "<string>",
      "agent_name": "<string>",
      "agent_description": "<string>",
      "agent_category": "<string>",
      "agent_tips": [
        "<string>"
      ],
      "agent_mobile_number": [
        "<string>"
      ],
      "stt": {},
      "llm": {},
      "tts": {},
      "sts": {},
      "call_analysis_enabled": true,
      "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
}
{
"detail": "<string>"
}
{
"detail": "<string>"
}

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