Langflow (1.6.5)

Retrieve the vertices order for a given flow.

Args:
flow_id (str): The ID of the flow.
background_tasks (BackgroundTasks): The background tasks.
data (Optional[FlowDataRequest], optional): The flow data. Defaults to None.
stop_component_id (str, optional): The ID of the stop component. Defaults to None.
start_component_id (str, optional): The ID of the start component. Defaults to None.
session (AsyncSession, optional): The session dependency.

Returns:
VerticesOrderResponse: The response containing the ordered vertex IDs and the run ID.

Raises:
HTTPException: If there is an error checking the build status.

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

Get events for a specific build job.

Cancel a specific build job.

Build a vertex instead of the entire graph.

Args:
flow_id (str): The ID of the flow.
vertex_id (str): The ID of the vertex to build.
background_tasks (BackgroundTasks): The background tasks dependency.
inputs (Optional[InputValueRequest], optional): The input values for the vertex. Defaults to None.
files (List[str], optional): The files to use. Defaults to None.
current_user (Any, optional): The current user dependency. Defaults to Depends(get_current_active_user).

Returns:
VertexBuildResponse: The response containing the built vertex information.

Raises:
HTTPException: If there is an error building the vertex.

Build a vertex instead of the entire graph.

This function is responsible for building a single vertex instead of the entire graph.
It takes the flow_id and vertex_id as required parameters, and an optional session_id.
It also depends on the ChatService and SessionService services.

If session_id is not provided, it retrieves the graph from the cache using the chat_service.
If session_id is provided, it loads the session data using the session_service.

Once the graph is obtained, it retrieves the specified vertex using the vertex_id.
If the vertex does not support streaming, an error is raised.
If the vertex has a built result, it sends the result as a chunk.
If the vertex is not frozen or not built, it streams the vertex data.
If the vertex has a result, it sends the result as a chunk.
If none of the above conditions are met, an error is raised.

If any exception occurs during the process, an error message is sent.
Finally, the stream is closed.

Returns:
A StreamingResponse object with the streamed vertex data in text/event-stream format.

Raises:
HTTPException: If an error occurs while building the vertex.

Build a public flow without requiring authentication.

This endpoint is specifically for public flows that don't require authentication.
It uses a client_id cookie to create a deterministic flow ID for tracking purposes.

The endpoint:
1. Verifies the requested flow is marked as public in the database
2. Creates a deterministic UUID based on client_id and flow_id
3. Uses the flow owner's permissions to build the flow

Requirements:
- The flow must be marked as PUBLIC in the database
- The request must include a client_id cookie

Args:
flow_id: UUID of the public 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
flow_name: Optional name for the flow
request: FastAPI request object (needed for cookie access)
queue_service: Queue service for job management
event_delivery: Optional event delivery type - default is streaming

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

Retrieve all component types with compression for better performance.

Returns a compressed response containing all available component types.

Executes a specified flow by ID with support for streaming and telemetry.

This endpoint executes a flow identified by ID or name, with options for streaming the response
and tracking execution metrics. It handles both streaming and non-streaming execution modes.

Args:
background_tasks (BackgroundTasks): FastAPI background task manager
flow (FlowRead | None): The flow to execute, loaded via dependency
input_request (SimplifiedAPIRequest | None): Input parameters for the flow
stream (bool): Whether to stream the response
api_key_user (UserRead): Authenticated user from API key
request (Request): The incoming HTTP request

Returns:
Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results
or a RunResponse with the complete execution results

Raises:
HTTPException: For flow not found (404) or invalid input (400)
APIException: For internal execution errors (500)

Notes:
- Supports both streaming and non-streaming execution modes
- Tracks execution time and success/failure via telemetry
- Handles graceful client disconnection in streaming mode
- Provides detailed error handling with appropriate HTTP status codes
- In streaming mode, uses EventManager to handle events:
- "add_message": New messages during execution
- "token": Individual tokens during streaming
- "end": Final execution result

Run a flow using a webhook request.

Args:
flow (Flow, optional): The flow to be executed. Defaults to Depends(get_flow_by_id).
user (User): The flow user.
request (Request): The incoming HTTP request.
background_tasks (BackgroundTasks): The background tasks manager.

Returns:
dict: A dictionary containing the status of the task.

Raises:
HTTPException: If the flow is not found or if there is an error processing the request.

Executes a specified flow by ID with optional input values, output selection, tweaks, and streaming capability.

This endpoint supports running flows with caching to enhance performance and efficiency.

### Parameters:
- flow_id (str): The unique identifier of the flow to be executed.
- inputs (List[InputValueRequest], optional): A list of inputs specifying the input values and components
for the flow. Each input can target specific components and provide custom values.
- outputs (List[str], optional): A list of output names to retrieve from the executed flow.
If not provided, all outputs are returned.
- tweaks (Optional[Tweaks], optional): A dictionary of tweaks to customize the flow execution.
The tweaks can be used to modify the flow's parameters and components.
Tweaks can be overridden by the input values.
- stream (bool, optional): Specifies whether the results should be streamed. Defaults to False.
- session_id (Union[None, str], optional): An optional session ID to utilize existing session data for the flow
execution.
- api_key_user (User): The user associated with the current API key. Automatically resolved from the API key.

### Returns:
A RunResponse object containing the selected outputs (or all if not specified) of the executed flow
and the session ID.
The structure of the response accommodates multiple inputs, providing a nested list of outputs for each input.

### Raises:
HTTPException: Indicates issues with finding the specified flow, invalid input formats, or internal errors during
flow execution.

### Example usage:
json<br>POST /run/flow_id<br>x-api-key: YOUR_API_KEY<br>Payload:<br>{<br> "inputs": [<br> {"components": ["component1"], "input_value": "value1"},<br> {"components": ["component3"], "input_value": "value2"}<br> ],<br> "outputs": ["Component Name", "component_id"],<br> "tweaks": {"parameter_name": "value", "Component Name": {"parameter_name": "value"}, "component_id": {"parameter_name": "value"}}<br> "stream": false<br>}<br>

This endpoint facilitates complex flow executions with customized inputs, outputs, and configurations,
catering to diverse application requirements.

Endpoint to process an input with a given flow_id.

Endpoint to process an input with a given flow_id.

Get the status of a task by ID (Deprecated).

This endpoint is deprecated and will be removed in a future version.

Upload a file for a specific flow (Deprecated).

This endpoint is deprecated and will be removed in a future version.

Update an existing custom component with new code and configuration.

Processes the provided code and template updates, applies parameter changes (including those loaded from the
database), updates the component's build configuration, and validates outputs. Returns the updated component node as
a JSON-serializable dictionary.

Raises:
HTTPException: If an error occurs during component building or updating.
SerializationError: If serialization of the updated component node fails.

Retrieve the current application configuration settings.

Returns:
ConfigResponse: The configuration settings of the application.

Raises:
HTTPException: If an error occurs while retrieving the configuration.

Retrieve a list of flows with pagination support.

Args:
current_user (User): The current authenticated user.
session (Session): The database session.
settings_service (SettingsService): The settings service.
components_only (bool, optional): Whether to return only components. Defaults to False.

get_all (bool, optional): Whether to return all flows without pagination. Defaults to True.
This field must be True because of backward compatibility with the frontend - Release: 1.0.20

folder_id (UUID, optional): The project ID. Defaults to None.
params (Params): Pagination parameters.
remove_example_flows (bool, optional): Whether to remove example flows. Defaults to False.
header_flows (bool, optional): Whether to return only specific headers of the flows. Defaults to False.

Returns:
list[FlowRead] | Page[FlowRead] | list[FlowHeader]
A list of flows or a paginated response containing the list of flows or a list of flow headers.

Delete multiple flows by their IDs.

Args:
flow_ids (List[str]): The list of flow IDs to delete.
user (User, optional): The user making the request. Defaults to the current active user.
db (Session, optional): The database session.

Returns:
dict: A dictionary containing the number of flows deleted.

Read a flow.

Update a flow.

Delete a flow.

Read a public flow.