Get Workflow
Retrieve a workflow with its complete typed graph inline
{name, description, nodes, edges} subset is the exact shape POST /v3/workflows/ accepts — strip the read-only id, created_at, and updated_at (unknown fields are rejected with 422) and feed the remainder to PATCH /v3/workflows/{workflow_id}/; its Python example shows the one-liner.
Every field in an extract node carries its server-assigned persistent_id — the stable identity that survives renames. Echo it unchanged when you PATCH to keep analytics, ground truth, and quality metrics attached to the field (see the migration guide).
/definition/ endpoint in v3 — the workflow read is the round-trippable definition.Authorizations
API key issued from app.anyformat.ai/api-key. Send as Authorization: Bearer <key>.
Path Parameters
Response
Successful Response
A workflow with its complete typed graph inline.
{name, description, nodes, edges} is the exact shape
POST /v3/workflows/ accepts — mutate it and feed it back to edit.
Unique identifier of the workflow (hyphenated UUID).
"0686bb97-8c30-70f0-8000-97669e000eb8"
Human-readable name of the workflow.
"Invoice Processing"
Typed graph nodes (parse / classify / splitter / extract / validate).
- ParseNode
- ClassifyNode
- SplitterNode
- ExtractNode
- ValidateNode
Optional description of what this workflow extracts.
"A workflow for processing invoices and retrieving invoice details."
Timestamp when the workflow was created (ISO 8601).
Timestamp when the workflow was last modified (ISO 8601).
Directed edges between the graph nodes.
