Skip to main content
PUT
Update agent

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

Body

application/json
name
string

Agent name

Required string length: 1 - 100
instructions
string

System prompt

channelInstructions
object | null

Per-channel instruction overrides

model
enum<string>

AI model

Available options:
gpt-4o,
gpt-4o-mini,
o4-mini,
gpt-oss-120b,
gpt-oss-20b,
gpt-5,
gpt-5.1,
gpt-5.2,
gpt-5.4,
gpt-5.4-mini,
gpt-5.4-nano,
gpt-5.5,
gpt-5.6-terra,
gpt-5.6-luna,
gpt-5-mini,
gpt-5-nano,
claude-opus-4-8,
claude-opus-4-7,
claude-opus-4-6,
claude-sonnet-4-6,
claude-opus-4-5,
claude-haiku-4-5,
claude-sonnet-4-5,
gemini-2.5-pro,
gemini-3-flash,
gemini-3.1-flash-lite,
gemini-3.1-pro,
gemini-3.5-flash,
gemini-3.5-flash-lite,
gemini-3.6-flash,
grok-3,
grok-3-mini,
grok-4,
DeepSeek-V3,
DeepSeek-R1,
DeepSeek-V4-Flash,
Llama-4-Scout-17B-16E-Instruct,
Llama-4-Maverick-17B-128E-Instruct-FP8,
kimi-k2,
mistral-medium-3.5,
mistral-small-2603,
glm-5.2
Example:

"gpt-5.1"

temp
number

Temperature (0–1)

Required range: 0 <= x <= 1
visibility
enum<string>

Visibility

Available options:
public,
private
allowedDomains
string[] | null

Allowed embed domains

suggestedMessages
object[] | null

Suggested messages

initialMessages
string[]

Initial messages

creditLimit
integer | null

Per-agent credit limit (null = no limit)

notificationsSettings
object | null

Email notification settings (null = disable all notifications)

ipRateLimits
object | null

IP-based rate limit settings (partial update; null = reset to defaults)

voiceSettings
object | null

Voice mode configuration (null = disable voice mode)

Response

Agent updated

success
enum<boolean>
required
Available options:
true