Run Workflow
Create a fresh workflow run.
Create a workflow run. The canonical API route is flat:Documentation Index
Fetch the complete documentation index at: https://docs.retab.com/llms.txt
Use this file to discover all available pages before exploring further.
workflow_id belongs
in the request body, not in the URL.
The response returns immediately with lifecycle.status set to "running" or
"pending" — use the Get Run endpoint to check for updates.
Workflows can accept two types of inputs:
- documents: File inputs for Document (start) blocks
- json_inputs: JSON data for JSON Input (start_json) blocks
Authorizations
Body
Create a new workflow run from a workflow id, an optional version selector, and optional inputs.
Workflow id for the fresh run.
Mapping of start_document block IDs to their input documents.
Mapping of start-json block IDs to their input JSON data.
Workflow version to run: 'production', 'draft', or a pinned version id like 'ver_...'. Only valid for fresh-run creation.
"production"
"draft"
"ver_abc123def456"
Response
Successful Response
A single execution of a workflow.
Unique ID for this run
ID of the workflow that was run
Content-addressed workflow version used for this run.
What started this run
The run has been created but execution has not started.
- PendingRun
- RunningRun
- AwaitingReviewRun
- CompletedTerminal
- ErrorTerminal
- CancelledTerminal
All timing information
Input payloads supplied at run creation time