Skip to main content
PUT
Update agent

Authorizations

Authorization
string
header
required

JWT authentication token

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Path Parameters

id
string
required

Agent ID

Body

application/json
name
string

The agent's name on the platform.

welcome_message
object | null

Welcome message. null removes it.

prompts
object

The agent's prompts. Only the fields sent change; lists sent replace the current ones.

agent_flow
string

ID of the agent's execution flow.

Minimum string length: 1
status
enum<string>

The agent's status.

Available options:
ACTIVE,
DRAFT,
INACTIVE,
DELETED
general_config
object

General settings of the agent

model_config
object
specialist_config
object

Specialist settings (qualification and ICP)

avatar_color
string

The agent's avatar color.

avatar_initials
string

Initials shown on the avatar (up to 2 characters).

Maximum string length: 2
personality_presets
enum<string>[]

Ready-made personality profiles (up to 3).

Maximum array length: 3
Available options:
FRIENDLY,
DIDACTIC,
CURIOUS,
FORMAL,
PLAYFUL,
PERSUASIVE
knowledge_base
string[]

IDs of the knowledge items the agent consults.

Response

200 - application/json
_id
object
required
name
string
required
agent_flow
object
required
prompts
object
required
company
object
required
model_config
object
required
status
enum<string>
required
Available options:
ACTIVE,
DRAFT,
INACTIVE,
DELETED
general_config
object
specialist_config
object
knowledge_base
object[]
avatar_color
string
avatar_initials
string
personality_presets
enum<string>[]
Available options:
FRIENDLY,
DIDACTIC,
CURIOUS,
FORMAL,
PLAYFUL,
PERSUASIVE
steps
object[]