Skip to main content
PATCH
Update agent (partial)

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

id
string
required

Agent ID

Body

application/json

Partial update — send only what you are changing. Omitted fields keep their current values. Use PATCH; there is no PUT handler.

name
string
Required string length: 1 - 100
description
string
status
enum<string>
Available options:
ACTIVE,
INACTIVE,
SUSPENDED
config
object

Any subset of the configuration fields.

changeNote
string

Recorded against the version this update creates. An update that changes nothing does not create a version.

Response

Agent updated successfully

An agent as returned by the API.

Note the asymmetry with the create/update payloads: you write configuration under config, and read it back under standardConfig (or customProvider). The type field tells you which one is present.

id
string
name
string
description
string | null
status
enum<string>

Only ACTIVE agents accept calls.

Available options:
ACTIVE,
INACTIVE,
SUSPENDED
type
enum<string>

standard agents carry standardConfig. custom agents use caller-supplied STT/LLM/TTS providers and carry customProvider.

Available options:
standard,
custom
workspaceId
string | null

The workspace this agent belongs to.

createdAt
string<date-time>
updatedAt
string<date-time>
standardConfig
object

Present when type is standard.

actions
object[]

Actions attached to this agent.

knowledgeBases
object[]

Knowledge bases attached to this agent.