Sign in
Chat

Build Flow

Build and process a flow, returning a job ID for event polling.<br><br>This endpoint requires authentication through the CurrentActiveUser dependency.<br>For public flows that don't require authentication, use the /build_public_tmp/flow_id/flow endpoint.<br><br>Args:<br> flow_id: UUID of the flow to build<br> background_tasks: Background tasks manager<br> inputs: Optional input values for the flow<br> data: Optional flow data<br> files: Optional files to include<br> stop_component_id: Optional ID of component to stop at<br> start_component_id: Optional ID of component to start from<br> log_builds: Whether to log the build process<br> current_user: The authenticated user<br> queue_service: Queue service for job management<br> flow_name: Optional name for the flow<br> event_delivery: Optional event delivery type - default is streaming<br><br>Returns:<br> Dict with job_id that can be used to poll for build status

post/api/v1/build/{flow_id}/flow

Path parameters

flow_idstring uuid required

Query parameters

stop_component_idstring nullable
start_component_idstring nullable
log_buildsboolean
flow_namestring nullable
event_delivery'streaming' | 'direct' | 'polling'

Request body

filesstring[] nullable

Example request

{
  "inputs": {
    "components": [
      "components_id",
      "Component Name"
    ],
    "input_value": "input_value",
    "session": "session_id"
  }
}

Response

Successful Response

{"stackTrail":"paths:/api/v1/build/{flow_id}/flow:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes