Skip to main content
POST
Update an Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version
enum<string>
required
Available options:
2026-08-31
idempotency-key
string
Maximum string length: 255

Path Parameters

agent_id
string
required
Pattern: ^agent_[0-9a-f]{32}$

Body

application/json
description
string | null
refresh_connection_bindings
string[]
Maximum array length: 20
Required string length: 1 - 255
mcp_servers
object[] | null
Maximum array length: 20
metadata
object | null

Metadata changes whose string values upsert and null values remove keys.

model

Replaces the model. A replacement that omits a provider or model_credential_id the Agent holds is refused with a validation.malformed error naming the field, because it would change the provider or payer. Resend the held value to keep it; send a different value or null to change it, together with the Agent version you observed. Omit model to keep the model and its supply unchanged.

name
string
Required string length: 1 - 255
skills
object[] | null
system
string | null
tools
object[] | null
Maximum array length: 128
version
integer

The Agent version this update was made against; a stale value is refused with validation.conflict. Required when model changes the held provider or model_credential_id. A selected credential must be an active credential of this Workspace for the model's provider.

Required range: x > 0
workload_trust
object | null
skill_selection
object

Response

ManagedAgentsAgent

id
string
required
Pattern: ^agent_[0-9a-f]{32}$
archived_at
string | null
required
created_at
string
required
connection_bindings
object[]
required
Maximum array length: 20
model
object
required
name
string
required
Required string length: 1 - 255
harness
string
required

a harness catalog name this deployment serves: claude-code, codex, deepseek, openclaw, openclaw-connected, opencode, pi

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})(?:@(?:latest|[1-9][0-9]{0,8}))?$
description
string | null
required
mcp_servers
object[]
required
metadata
object
required

at most 16 correlation pairs with keys of 1 to 64 characters

skills
object[]
required
system
string | null
required
tools
object[]
required
workload_trust
object
required
type
enum<string>
required
Available options:
agent
updated_at
string
required
version
integer
required
skill_selection
object