Patch Flow Execution Status
Patch the status of a flow execution.
Authorizations
API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY
Example:
JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN
Example:
Path Parameters
Query Parameters
Valid status values for flow execution lifecycle.
Status Transitions: queued → running → in_progress → completed → failed
Status Definitions: - queued: Execution created but workflow not yet started - running: Workflow started, initial tasks executing - in_progress: Workflow actively processing tasks - completed: All tasks finished successfully - failed: One or more tasks failed, workflow stopped - deleted: Soft deleted, hidden from list operations - stale: Previously completed but data is now outdated
queued, running, in_progress, completed, failed, deleted, stale, awaiting_input Response
Successful Response
Response model for flow execution operations.
Represents a single flow execution instance with its current state and metadata. Flow executions are runtime instances of flow definitions that process input data through a series of tasks defined in the flow's workflow.
UUID of the flow definition being executed. References the parent flow that defines the workflow structure.
"550e8400-e29b-41d4-a716-446655440000"
Version number of the flow definition used for this execution. Execution continues on the same version even if flow is updated. Ensures consistency throughout execution lifecycle.
x >= 13
Input data provided when execution was created. Schema is defined by the flow definition. Commonly includes: file_key, document_url, or custom parameters. Structure varies by flow type.
UUID of the organization that owns this execution. Used for access control and data isolation. All executions are scoped to an organization.
"660e8400-e29b-41d4-a716-446655440001"
Current execution status. Possible values: 'queued', 'running', 'in_progress', 'completed', 'failed', 'deleted', 'stale'. Status transitions: queued → running → in_progress → completed/failed. Use 'completed' to indicate success, 'failed' for errors.
"running"