> ## 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.
# Get Agent
> Retrieve complete agent configuration by ID
## Overview
Get the full configuration of a specific agent, including STT/LLM/TTS settings, prompt, tools, widget config, and associated media files.
## Authentication
Your eigi.ai API key. Must be prefixed with `vk_`.
## Path Parameters
The unique agent ID.
Example: `68ea2517dbb84c09bae1ba0a`
## Response
Agent ID.
Agent name.
Agent description.
`INBOUND` or `OUTBOUND`.
Agent category.
Speech-to-Text configuration.
Large Language Model configuration.
Text-to-Speech configuration.
Prompt reference with name, version, and content.
Agent's greeting message.
Configured tools.
Widget configuration.
Media files associated with the agent (avatars, images).
ISO 8601 creation timestamp.
ISO 8601 last update timestamp.
## OpenAPI
````yaml GET /v1/public/agents/{agent_id}
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/{agent_id}:
get:
tags:
- Agents
summary: Get Agent
description: >-
Retrieve complete agent configuration by ID, including all STT/LLM/TTS
settings, prompt, tools, and widget config.
operationId: getAgent
parameters:
- name: agent_id
in: path
required: true
description: The unique agent ID
schema:
type: string
example: 68ea2517dbb84c09bae1ba0a
responses:
'200':
description: Successfully retrieved agent
content:
application/json:
schema:
$ref: '#/components/schemas/AgentResponse'
'401':
description: Unauthorized - Invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden - Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not found
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.
````