Skip to main content
PATCH
Update Agent

Authorizations

X-API-Key
string
header
required

Workspace API key (e.g. kej_live_...)

Path Parameters

agent_id
string
required

Body

application/json

Partial update for an agent.

name
string | null
Required string length: 1 - 255
description
string | null
avatar
string | null
is_active
boolean | null
memory_enabled
boolean | null
call_settings
CallSettingsInput · object | null

Unified call settings -- controls call window, retry, scoring, tags, and post-call behavior.

Can be set at agent level or campaign level. Null fields inherit from the parent level. Hierarchy (lowest -> highest priority): System Defaults -> Workspace -> Agent -> Campaign -> API Override.

Example:

Response

Successful Response

Full agent (persona) response (public-safe).

id
string
required
name
string
required
is_active
boolean
required
memory_enabled
boolean
required
description
string | null
call_settings
CallSettingsInput · object | null

Unified call settings -- controls call window, retry, scoring, tags, and post-call behavior.

Can be set at agent level or campaign level. Null fields inherit from the parent level. Hierarchy (lowest -> highest priority): System Defaults -> Workspace -> Agent -> Campaign -> API Override.

Example:
voice_configs
VoiceConfigResponse · object[]
tools
AgentToolResponse · object[]
created_at
string | null
updated_at
string | null