v21

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01144108427.9 KB

Chat

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 event_delivery: Optional event delivery type - default is streaming

Returns: 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"}