Skip to main content
GET
Get Agent

Overview

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

Authentication

string
required
Your eigi.ai API key. Must be prefixed with vk_.

Path Parameters

string
required
The unique agent ID.Example: 68ea2517dbb84c09bae1ba0a

Response

string
Agent ID.
string
Agent name.
string
Agent description.
string
INBOUND or OUTBOUND.
string
Agent category.
object
Speech-to-Text configuration.
object
Large Language Model configuration.
object
Text-to-Speech configuration.
object
Prompt reference with name, version, and content.
string
Agent’s greeting message.
object
Configured tools.
object
Widget configuration.
array
Media files associated with the agent (avatars, images).
string
ISO 8601 creation timestamp.
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)

call_analysis_enabled
boolean

Whether call analysis is enabled for the agent

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