Skip to main content
POST
Edit an agent from instructions

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 edit.

Body

application/json
instructions
string
required

Natural-language description of the changes to make to the agent.

Required string length: 1 - 65536
model
string

Model id to run with (for example, anthropic/claude-haiku-4-5). Omit to use the default model, currently anthropic/claude-sonnet-5-5. Supported ids: https://agent.docs.creao.ai/developer-api/supported-models. Unknown ids return 400 MODEL_NOT_SUPPORTED; models not available on your plan return 403 MODEL_NOT_ALLOWED.

Maximum string length: 100
release_note
string | null

Optional caller-provided release note for the persisted agent update.

Maximum string length: 2000

Response

Agent edit accepted.

run_id
string<uuid>
required

Backing CREAO CLI run ID for polling/debugging.

agent_id
string<uuid>
required
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled
result
object

Terminal edit result when the edit succeeds.

usage
object

Settlement credits plus an optional per-model breakdown for the run. Omitted when the run incurred no cost and collected no model usage. models is present only for Super Agent–allowlisted accounts. Token fields appear only for token-metered capabilities. Per-image and per-second capabilities use generated_images or duration_seconds instead. kind tells the client which fields apply.

error
object
created_at
string<date-time>
started_at
string<date-time> | null
completed_at
string<date-time> | null