Skip to main content
PATCH
/
v1
/
public
/
agents
/
{agent_id}
Update Agent
curl --request PATCH \
  --url https://api.eigi.ai/v1/public/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agent_name": "Updated Support Agent",
  "prompt_content": "You are an updated customer support agent."
}
'
{
  "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

Update an existing agent’s configuration. Only the fields you provide will be updated — all other settings remain unchanged. If prompt_content is provided, a new version of the agent’s internal prompt is automatically created.

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 to update.Example: 68ea2517dbb84c09bae1ba0a

Request Body

All fields are optional. Only provided fields will be updated.
agent_name
string
Updated agent name (1-100 characters).
agent_description
string
Updated description (max 500 characters).
agent_type
string
INBOUND or OUTBOUND.
agent_category
string
Updated category.
stt
object
Updated STT configuration (no params allowed).
llm
object
Updated LLM configuration (only temperature param allowed).
tts
object
Updated TTS configuration (only speed param allowed).
prompt_content
string
New prompt content — creates a new version of the agent’s internal prompt.
prompt
object
Reference an existing prompt by name and optionally version.
first_message_prompt
string
Updated greeting message.
tools
object
Update agent tools. Only specified tools are modified.
widget_config
object
Updated widget configuration.

Response

Returns the complete updated agent object with all configurations and timestamps.

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

Body

application/json

All fields are optional — only provided fields will be updated.

agent_name
string

Agent name

Required string length: 1 - 100
agent_description
string

Agent description

Maximum string length: 500
agent_type
enum<string>

Agent type

Available options:
INBOUND,
OUTBOUND
agent_category
enum<string>

Agent category

Available options:
Customer Service,
Sales,
Scheduling,
Research,
Healthcare,
Customer Success,
Education,
Finance,
HR,
Legal,
Productivity,
Creative,
IT/DevOps,
E-commerce,
Entertainment,
Travel,
Wellness,
Anime,
Cartoon,
Gaming,
Lifestyle,
other
agent_tips
string[]

Usage tips

agent_mobile_number
string[]

Mobile numbers associated with the agent

stt
object
llm
object
tts
object
prompt_content
string

New prompt content — creates a new version of the agent's internal prompt

prompt
object

Reference to an existing prompt

first_message_prompt
string

Agent's greeting message

tools
object

Configure agent tools. Each tool can be true (enable), false (disable), or an object with configuration.

widget_config
object

Widget configuration

Response

Agent updated successfully

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