Run a workflow with the provided input documents.
This endpoint creates a workflow run and starts execution in the background:
Run a workflow with the provided inputs. This endpoint creates a workflow run and starts execution in the background. The response returns immediately withDocumentation Index
Fetch the complete documentation index at: https://docs.retab.com/llms.txt
Use this file to discover all available pages before exploring further.
lifecycle.kind set to "running" or "pending" — use the Get Run endpoint to check for updates.
Workflows can accept two types of inputs:
client.workflows.get_entities(workflow_id) first and read .start_blocks / .start_json_blocks.
Request to run a workflow with input documents and/or JSON.
Documents are provided as a dict mapping start block IDs to document inputs. JSON inputs are provided as a dict mapping start_json block IDs to JSON data.
Example: { "documents": { "start-block-1": { "filename": "invoice.pdf", "mime_type": "application/pdf", "content": "base64_encoded_content..." } }, "json_inputs": { "start-json-block-1": { "customer_name": "John Doe", "invoice_number": "INV-001" } }, }
Mapping of start 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_...'
"production"
"draft"
"ver_abc123def456"
Successful Response
Public workflow run response without tenant isolation fields.
Unique ID for this run
Workflow + snapshot reference
Manual run started by a user from the dashboard.
The run has been created but execution has not started.
All timing information
Input payloads supplied at run creation time