Skip to main content
PATCH
Update an Agent

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Path Parameters

agentId
string
required

Body

application/json
name
string

Updated display name of the agent.

Minimum string length: 1
Example:

"Ops escalation coordinator"

desc
string

Updated operator-facing description.

Example:

"Owns production escalations and stakeholder updates."

status
enum<string>

Optional status transition, for example ACTIVE or PAUSED.

Available options:
ACTIVE,
PAUSED,
DISABLED
Example:

"PAUSED"

serviceAccountUserId
string<uuid>

Replacement service-account execution principal.

Example:

"11111111-1111-4111-8111-111111111111"

ownerId
string<uuid>

Updated owner id.

Example:

"22222222-2222-4222-8222-222222222222"

ownerType
string

Updated owner type.

Example:

"GROUP"

metadata
object

Replacement resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:
config
object

Replacement Agent identity and runtime defaults.

Example:
policy
object

Replacement persisted policy constraints. Execution-time route metadata stays derived from the current turn.

Example:
version
number

Optimistic locking version.

Required range: x >= 0
Example:

12

Response

200 - undefined
Last modified on September 5, 2026