Skip to main content

API Reference

See the full request/response schema and parameters in the API Reference.

Workflow definition

A workflow definition is a directed graph of blocks connected by edges:
  • blocks: each block has a block_name (see Workflow Blocks), an optional block_id, and a specs object.
  • edges: each edge has a from_block_id and a to_block_id.
This shape is used in both Create Workflow and Update Workflow requests. A block_id that is missing or is not a UUID is replaced with a new UUID on every save, and the edges are rewritten to match.

Limits

A save over a limit stores nothing. For the error responses, see Handling Errors.

List workflows

Retrieve the workflows in your organization.
Returns the workflows without their block definitions.

Get workflow

Retrieve a specific workflow including its complete block graph.
Runs use the last valid saved definition; a draft that failed validation never runs. Any valid update takes effect from the next run. The workflow’s status and updated_at change as runs progress, so track each run with its live status. edit_revision changes only when the name, description, or graph changes, including edits made in the web app.

Create workflow

Create a new workflow with a block graph definition.
Required body fields: workflow_name, workflow_description, and workflow_definition. Pass an optional id containing a valid UUID to use a custom workflow ID; otherwise one is auto-generated.

Example request

Definitions are validated before saving. With an API key, an invalid definition is rejected and nothing is stored; see Validation errors. With an OAuth access token, it is saved as a draft, which never runs. The response is the saved workflow. Its status is created, or draft when an OAuth request saved a draft.

Update workflow

Update an existing workflow’s name, description, or block definition.
Pass workflow_id as a query parameter. Include only the fields to change. Content updates to an existing workflow require expected_revision, copied from the latest GET /workflows/{workflow_id} response. Lock updates do not require it.
If the workflow does not exist and no expected_revision is sent, the request creates it, and workflow_definition is required. An invalid definition is handled as in Create workflow, and the last valid saved definition is kept.

Validation errors

Definitions are validated before saving. For the checks and the validation_errors response, see Handling Errors. One check runs only when a run starts: a source block with no data yet, such as a search that has not run or a file that was never uploaded (MISSING_DATA_SOURCE), saves but rejects the run with the same validation_errors shape.

Delete workflow

Permanently delete a workflow.
Pass workflow_id as a query parameter. The response is the deleted workflow. Locked workflows are deleted too.
Deleting a workflow also deletes its schedules and its run history. Its runs, their live status, and their results can no longer be read. Download the results you need before deleting.
Use a new ID for a new workflow.

Templates

These routes are not under /v1 yet and will keep working when /v1 replacements are introduced. Templates are ready-made workflow definitions from the Sixtyfour catalog. Each template carries its full blocks and edges, so you can pass them to Create Workflow as your workflow_definition. Template endpoints are rate limited; see Rate limits. Both list endpoints accept these optional query parameters: Each template includes key, scope (global for the catalog, org for your organization’s templates), id, slug, name, description, category, tags, featured, difficulty, estimated_time, use_case, preview_blocks, blocks, edges, author_name, created_at, and updated_at.

Pricing

See Credit Costs for more information.