Update Agent - eigi.ai Documentation

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.",
  "call_analysis_enabled": true,
  "call_analysis_prompt": {
    "prompt_name": "support_call_analysis",
    "custom_prompt": "Return the summary, customer intent, and next best action."
  },
  "call_analysis_schema": {
    "summary": {
      "type": "str"
    },
    "customer_intent": {
      "type": "Optional[str]"
    },
    "next_best_action": {
      "type": "str"
    }
  }
}
'

{
  "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"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

PATCH

public

agents

{agent_id}

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.",
  "call_analysis_enabled": true,
  "call_analysis_prompt": {
    "prompt_name": "support_call_analysis",
    "custom_prompt": "Return the summary, customer intent, and next best action."
  },
  "call_analysis_schema": {
    "summary": {
      "type": "str"
    },
    "customer_intent": {
      "type": "Optional[str]"
    },
    "next_best_action": {
      "type": "str"
    }
  }
}
'

{
  "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"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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. If call_analysis_prompt.custom_prompt is provided, a new version of the analysis prompt is automatically created before the agent is updated. Only send call_analysis_enabled, call_analysis_prompt, and call_analysis_schema when you explicitly want to configure call analysis. If call_analysis_enabled is true, provide call_analysis_prompt as well.

Try It Behavior

In Try it, llm is shown as a single object.

For standard providers, fill llm.params.temperature only.
For CUSTOM_LLM, fill llm.params.base_url, llm.params.api_key, and optionally llm.params.API_TYPE.

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.

Provider	Allowed params
STT	No params allowed (must be empty `{}`)
STS	No public API param restrictions
LLM	Standard providers: only `temperature` (0.0 - 2.0). `CUSTOM_LLM`: requires `base_url` plus `api_key`; optional `API_TYPE` and `temperature`
TTS	Only `speed`

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.

agent_tips

array

Updated array of usage tip strings for the agent.

agent_mobile_number

array

Updated mobile numbers associated with the agent.

stt

object

Updated STT configuration (no params allowed).

Show properties

provider_name

string

required

STT provider: DEEPGRAM, OPENAI, WHISPER, or GROK.

model_name

string

required

Model name for the STT provider.

language

string

required

Language code.

params

object

Must be empty {} for public API requests.

llm

object

Updated LLM configuration. Standard providers only allow temperature. CUSTOM_LLM requires base_url plus api_key, and optionally accepts API_TYPE and temperature.

Show properties

provider_name

string

required

LLM provider: OPENAI, OPENAI_RESPONSES, ANTHROPIC, GOOGLE, GROK, OPENROUTER, or CUSTOM_LLM.

model_name

string

required

Model name for the LLM provider.

params

object

For standard LLM providers, only temperature (0.0-2.0) is allowed. For CUSTOM_LLM, provide base_url, api_key, and optionally API_TYPE (CHAT_COMPLETION or RESPONSES) and temperature. If API_TYPE is omitted, it defaults to CHAT_COMPLETION.

tts

object

Updated TTS configuration (only speed param allowed).

Show properties

provider_name

string

required

TTS provider: CARTESIA, DEEPGRAM, ELEVENLABS, SARVAM, GOOGLE, HUME, or GROK.

model_name

string

required

Model name for the TTS provider.

language

string

required

Language code.

voice_id

string

required

Voice ID for the TTS provider.

params

object

Only speed is allowed.

sts

object

Updated Speech-to-Speech configuration.

Show properties

speech_to_speech_enabled

boolean

Whether speech-to-speech is enabled.

provider_name

string

required

STS provider: GOOGLE, OPENAI, or GROK.

model_name

string

required

Model name for the STS provider.

voice_id

string

required

Voice ID for the STS provider.

language

string

required

Language code.

params

object

Additional provider-specific STS parameters.

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.

call_analysis_prompt

object

Updated call analysis prompt reference or inline analysis prompt content.

Show properties

prompt_name

string

required

Name of an existing analysis prompt.

prompt_version

integer

Specific analysis prompt version to use (omit for latest).

custom_prompt

string

Inline analysis prompt content. If provided, a new analysis prompt version is created before linking it to the agent.

call_analysis_enabled

boolean

Toggle call analysis on or off for the agent. Set this to true only when you want call analysis to run. If true, provide call_analysis_prompt as well.

call_analysis_schema

object

Updated schema describing the structured JSON output expected from call analysis.

first_message_prompt

string

Updated greeting message.

tools

object

Update agent tools. Only specified tools are modified.

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

Show child attributes

llm

object

LLM configuration. Use provider_name to choose a standard provider or CUSTOM_LLM. For standard providers, only params.temperature applies. For CUSTOM_LLM, use params.base_url, params.api_key, and optional params.API_TYPE.

Show child attributes

tts

object

Show child attributes

call_analysis_prompt

object

Optional call analysis prompt reference. Provide custom_prompt to create a new analysis prompt version before linking it to the agent.

Show child attributes

call_analysis_enabled

boolean

Toggle call analysis on or off for the agent. Set to true only when you want call analysis to run; when true, provide call_analysis_prompt as well.

call_analysis_schema

object

Optional schema for structured call analysis output, keyed by field name.

Show child attributes

Example:

{
  "summary": { "type": "str" },
  "customer_intent": { "type": "Optional[str]" },
  "follow_up_required": { "type": "bool" }
}

prompt_content

string

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

prompt

object

Reference to an existing prompt

Show child attributes

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.

Show child attributes

Widget configuration

Show child attributes

Response

Agent updated successfully

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

Show child attributes

first_message_prompt

string

Agent's greeting message

dynamic_variables

string[]

Dynamic variables in the prompt

tools

object

Configured tools

Widget configuration

MediaFiles

object[]

Media files associated with the agent

Show child attributes

created_at

string<date-time>

Creation timestamp

updated_at

string<date-time>

Last update timestamp

Get Agent Dynamic Variables Delete Agent

​Overview

​Try It Behavior

​Authentication

​Path Parameters

​Request Body

​Response

Authorizations

Path Parameters

Body

Response

Overview

Try It Behavior

Authentication

Path Parameters

Request Body

Response