Skip to main content
POST
/
v1
/
agents
/
{agent_id}
/
edits
Edit an agent from instructions
curl --request POST \
  --url https://developer.creao.ai/v1/agents/{agent_id}/edits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": "Add a valuation sensitivity table for the selected ticker and include a short note on downside risk."
}
'
{
  "run_id": "11111111-1111-4111-8111-111111111111",
  "agent_id": "00000000-0000-4000-8000-000000000000",
  "status": "queued",
  "created_at": "2026-07-03T10:00:00.000Z",
  "started_at": null,
  "completed_at": null
}

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
​
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 Developer API 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
​
error
object
​
created_at
string<date-time>
​
started_at
string<date-time> | null
​
completed_at
string<date-time> | null