Skip to main content

Build Flow

Build and process a flow, returning a job ID for event polling.

This endpoint requires authentication through the CurrentActiveUser dependency. For public flows that don't require authentication, use the /build_public_tmp/flow_id/flow endpoint.

Args: flow_id: UUID of the flow to build background_tasks: Background tasks manager inputs: Optional input values for the flow data: Optional flow data files: Optional files to include stop_component_id: Optional ID of component to stop at start_component_id: Optional ID of component to start from log_builds: Whether to log the build process current_user: The authenticated user queue_service: Queue service for job management flow_name: Optional name for the flow settings_service: Settings service

Returns: Dict with job_id that can be used to poll for build status

Path Parameters
flow_id uuid REQUIRED
Query Parameters
stop_component_id Stop Component Id
start_component_id Start Component Id
log_builds Log Builds
flow_name Flow Name
Request Body
inputs
data
files Files
Responses
200

Successful Response

Schema OPTIONAL
undefined
422

Validation Error

Schema OPTIONAL
detail object[] OPTIONAL
loc undefined[]
msg Message
type Error Type
Search