Skip to main content
An agent’s workflow — the diagram of blocks that decides what happens in a conversation, and when the AI is called. You edit a draft; publishing makes it a new live version. Keep the revision you read: saving and publishing need it.
Needs the agents:read scope.

Path parameters

Request

Response

200 OK: Each node has its id, the block it is, its label and summary, its outcomes, its place on the canvas (x, y) and its config. OMNI adds the block’s category, whether it calls the AI (ai), and, for a block that runs an action, the agent’s policy for it. A wire joins one outcome of a node — by its position in outcomes, from 0 — to another node. A version has its number, the note it was published with, who published it (by; null when published through the API), when (at), how many blocks it has and how many call the AI (ai_blocks), and whether it is the live one.

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault. Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.