Skip to main content
To run a workflow, see Workflows Overview.

Workflow definition

A definition is a graph of blocks connected by edges:
  • blocks: each block has a block_id you choose, a block_name and a specs object. See Workflow Blocks, or list them with GET /v1/workflows/blocks.
  • edges: each edge has a from_block_id and a to_block_id.
Create and update requests use the same shape.

Limits

A save over a limit stores nothing.

Create a workflow

Sixtyfour validates the definition before saving. An invalid definition is rejected with 422 and nothing is stored. With an OAuth access token, an invalid definition is saved as a draft, which never runs.
The response is the saved workflow. Keep its workflow_id and revision.
HTTP 201
A block_id that is not a UUID is replaced with a new UUID on save, and the edges are rewritten to match.

List workflows

GET /v1/workflows returns your organization’s workflows without their definitions. Results are paginated: pass next_cursor as cursor to read the next page, and set page_size to change the page length.
cURL
See the response example.

Get a workflow

Returns one workflow with its full definition.

Update a workflow

Send only the fields to change: name, description, definition or locked. Include the revision from your last read when you change name, description or definition. If the workflow changed since that read, the update is refused with 409 and nothing is saved.
The response is the updated workflow with a higher revision. Runs that already started keep the definition they started with. An update takes effect from the next run.

Delete a workflow

HTTP 200
Deleting a workflow also deletes its run history and stops its schedules. Download any output files you need first.

Templates

Templates are ready-made workflow definitions. Each template carries its full blocks and edges, so you can pass them as the definition when you create a workflow. GET /v1/templates accepts these optional query parameters:
cURL
Each item includes template_id, scope (global for the catalog, org for your organization’s templates), name, description, category, tags, blocks and edges. Template requests are rate limited. See Rate limits.

Errors

For error responses, see Handling Errors.

Pricing

Managing workflows is free. See Credit Costs for more information.
Integrations built on /workflows/create_workflow and the other original routes keep working. Legacy maps each one to its /v1 replacement.