Create and start a flow execution
Create a new flow execution and start workflow processing.
This endpoint creates a flow execution record and immediately starts the associated workflow processing. The execution is created with status ‘running’ and will be processed asynchronously by the execution engine.
Context:
- Flow executions represent runtime instances of flow definitions
- Each execution is isolated and maintains its own state
- Input data must conform to the flow’s input schema
- Executions are scoped to the user’s organization
- WebSocket notifications are sent on creation for real-time updates
Execution Flow:
- Validates flow exists and user has access
- Creates execution record in database
- Starts workflow processing asynchronously
- Sends WebSocket notification to connected clients
- Returns immediately (does not wait for completion)
Performance Notes:
- Response time: < 200ms (workflow starts asynchronously)
- Does not block on workflow completion
- WebSocket notifications sent in background task
Use Cases:
- Trigger flow execution from UI dashboard
- Automated flow execution via API integration
- Batch processing of multiple documents
- Event-driven workflow automation
Related Endpoints:
- GET /flow-executions/ - Check execution status
- GET /flow-executions - List all executions for a flow
- POST /flow-executions//execute - Re-execute failed 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:
Body
Request payload for creating a new flow execution.
This model defines the required data to start a new flow execution. The input schema must match the flow definition's expected input structure.
UUID of the flow definition to execute. Must be a valid, active flow accessible to your organization. The flow defines the workflow structure and task sequence.
"550e8400-e29b-41d4-a716-446655440000"
Input data for the flow execution. Schema is flow-specific. Common patterns: - Document processing: {'file_key': 'path/to/file.pdf'} - Data processing: {'document_url': 'gs://bucket/file.csv'} - Email processing: {'message_id': 'msg_123', 'attachments': []} Refer to flow definition for exact schema requirements.
Response
Flow execution created and started successfully
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"