Skip to main content
PATCH
Patch Flow Execution Status

Authorizations

X-API-Key
string
header
required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

Authorization
string
header
required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Path Parameters

flow_execution_id
string<uuid>
required

Query Parameters

status
enum<string>
required

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

Available options:
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.

created_at
string<date-time>
required
flow_id
string<uuid>
required

UUID of the flow definition being executed. References the parent flow that defines the workflow structure.

Example:

"550e8400-e29b-41d4-a716-446655440000"

flow_version
integer
required

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.

Required range: x >= 1
Example:

3

id
string<uuid>
required
input
Input · object
required

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.

Example:
modified_by
string
required
organization_id
string<uuid>
required

UUID of the organization that owns this execution. Used for access control and data isolation. All executions are scoped to an organization.

Example:

"660e8400-e29b-41d4-a716-446655440001"

status
string
required

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.

Example:

"running"

updated_at
string<date-time>
required