Skip to main content
PATCH
Update agent by replacing provided fields

Authorizations

Authorization
string
header
default:cr_sk_your_key_here
required

Account API key from Developer Console. Keys start with cr_sk_.

Path Parameters

agent_id
string<uuid>
required

Personal CREAO agent to update.

Body

application/json
name
string
Required string length: 1 - 255
description
string | null
version
string
skill_content
string

Replacement Markdown skill definition. UTF-8 content must be 256 KB or smaller.

Maximum string length: 262144
config_content
string

Replacement app config YAML. If config is also supplied, config wins for parsed config.

Maximum string length: 131072
config
object
dashboard_template
object | null

Replace or clear the dashboard template.

write_autonomy
enum<string>

External write autonomy for guarded connector actions (write and delete actions in connected services). full_auto performs them immediately. A run started through /v1 cannot collect an approval, so on those runs approval_required and blocked both leave the action unperformed; the run still completes and the agent is told why. In the browser app, approval_required waits for your approval. Reads always run.

Available options:
full_auto,
approval_required,
blocked
release_note
string | null

Optional changelog note for the update.

Maximum string length: 2000

Response

Agent updated.

agent_id
string<uuid>
required

Personal CREAO agent ID.

name
string
required
description
string | null
required
version
string
required
status
string
required

Current agent status. Created agents return active.

write_autonomy
enum<string>
required

External write autonomy for guarded connector actions (write and delete actions in connected services). full_auto performs them immediately. A run started through /v1 cannot collect an approval, so on those runs approval_required and blocked both leave the action unperformed; the run still completes and the agent is told why. In the browser app, approval_required waits for your approval. Reads always run.

Available options:
full_auto,
approval_required,
blocked
created_at
string<date-time>
required
updated_at
string<date-time>
required
skill_content
string | null

Full SKILL.md. Present on GET-by-id and PATCH. Omitted from list responses.

config_content
string | null

Raw config YAML. Present on GET-by-id and PATCH. Omitted from list responses.

config
object | null

Parsed config object. Present on GET-by-id and PATCH. Omitted from list responses.

dashboard_template
object | null

Dashboard template. Present on GET-by-id and PATCH. Omitted from list responses.