Skip to main content
GET
/
v1
/
public
/
agents
/
{agent_id}
Get Agent
curl --request GET \
  --url https://api.eigi.ai/v1/public/agents/{agent_id} \
  --header 'X-API-Key: <api-key>'
{
  "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"
}

​
Overview

Get the full configuration of a specific agent, including STT/LLM/TTS settings, prompt, tools, widget config, and associated media files.

​
Authentication

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

​
Path Parameters

​
agent_id
string
required
The unique agent ID.Example: 68ea2517dbb84c09bae1ba0a

​
Response

​
id
string
Agent ID.
​
agent_name
string
Agent name.
​
agent_description
string
Agent description.
​
agent_type
string
INBOUND or OUTBOUND.
​
agent_category
string
Agent category.
​
stt
object
Speech-to-Text configuration.
​
llm
object
Large Language Model configuration.
​
tts
object
Text-to-Speech configuration.
​
prompt
object
Prompt reference with name, version, and content.
​
first_message_prompt
string
Agent’s greeting message.
​
tools
object
Configured tools.
​
widget_config
object
Widget configuration.
​
MediaFiles
array
Media files associated with the agent (avatars, images).
​
created_at
string
ISO 8601 creation timestamp.
​
updated_at
string
ISO 8601 last update timestamp.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
agent_id
string
required

The unique agent ID

Response

Successfully retrieved agent

​
id
string

Agent ID

​
agent_name
string

Agent name

​
agent_description
string

Agent description

​
agent_type
enum<string>

Agent type

Available options:
INBOUND,
OUTBOUND
​
agent_category
string

Agent category

​
agent_tips
string[]

Usage tips

​
agent_mobile_number
string[]

Associated mobile numbers

​
stt
object

STT configuration

​
llm
object

LLM configuration

​
tts
object

TTS configuration

​
sts
object

STS configuration (if set)

​
prompt
object

Prompt reference

​
first_message_prompt
string

Agent's greeting message

​
dynamic_variables
string[]

Dynamic variables in the prompt

​
tools
object

Configured tools

​
widget_config
object

Widget configuration

​
MediaFiles
object[]

Media files associated with the agent

​
created_at
string<date-time>

Creation timestamp

​
updated_at
string<date-time>

Last update timestamp