diff --git a/404.html b/404.html index e8863606c9..29c41a1364 100644 --- a/404.html +++ b/404.html @@ -24,8 +24,8 @@ - - + + diff --git a/agent-tutorial.html b/agent-tutorial.html index 7321e47c02..fe044bfd79 100644 --- a/agent-tutorial.html +++ b/agent-tutorial.html @@ -24,8 +24,8 @@ - - + + diff --git a/agents-tools.html b/agents-tools.html index 42778165f7..6b0b979427 100644 --- a/agents-tools.html +++ b/agents-tools.html @@ -24,8 +24,8 @@ - - + + diff --git a/agents.html b/agents.html index 9d2cc75d6a..89bdcd76de 100644 --- a/agents.html +++ b/agents.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-build.html b/api-build.html index a5108cea25..cd9f277562 100644 --- a/api-build.html +++ b/api-build.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-files.html b/api-files.html index ecb3a3ac38..a76c0a6a25 100644 --- a/api-files.html +++ b/api-files.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-flows-run.html b/api-flows-run.html index 3ac75bc293..6d2773a3e5 100644 --- a/api-flows-run.html +++ b/api-flows-run.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-flows.html b/api-flows.html index 8720211be2..ccec95ffa8 100644 --- a/api-flows.html +++ b/api-flows.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-keys-and-authentication.html b/api-keys-and-authentication.html index 16b184eb78..e7f5216665 100644 --- a/api-keys-and-authentication.html +++ b/api-keys-and-authentication.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-logs.html b/api-logs.html index 29db9267a9..c3f398783d 100644 --- a/api-logs.html +++ b/api-logs.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-monitor.html b/api-monitor.html index 3d86620e07..5cd948444a 100644 --- a/api-monitor.html +++ b/api-monitor.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-openai-responses.html b/api-openai-responses.html index b79870ae5a..9e2958ae4a 100644 --- a/api-openai-responses.html +++ b/api-openai-responses.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-projects.html b/api-projects.html index 2d59fb3b44..c1507db70d 100644 --- a/api-projects.html +++ b/api-projects.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-reference-api-examples.html b/api-reference-api-examples.html index bcf760e7e9..4af9355244 100644 --- a/api-reference-api-examples.html +++ b/api-reference-api-examples.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-users.html b/api-users.html index 5bcd288709..0ccf68c08a 100644 --- a/api-users.html +++ b/api-users.html @@ -24,8 +24,8 @@ - - + + diff --git a/api.html b/api.html index 1b14725350..38a297e5a9 100644 --- a/api.html +++ b/api.html @@ -24,8 +24,8 @@ - - + + @@ -903,11 +903,11 @@ html([data-theme='dark']) data-styled.g138[id="sc-enPhjR"]{content:"fdfgWT,"}/*! -104.0616 -231.873,-231.248 z " fill="currentColor">

Langflow (1.6.4)

Download OpenAPI specification:Download

Chat

Retrieve Vertices Order Deprecated

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.

-
path Parameters
flow_id
required
string <uuid> (Flow Id)
query Parameters
Stop Component Id (string) or Stop Component Id (null) (Stop Component Id)
Start Component Id (string) or Start Component Id (null) (Start Component Id)
Request Body schema: application/json
Any of
nodes
required
Array of objects (Nodes)
edges
required
Array of objects (Edges)
Viewport (object) or Viewport (null) (Viewport)

Responses

Request samples

Content type
application/json
Example
{
  • "nodes": [
    ],
  • "edges": [
    ],
  • "viewport": { }
}

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
  • "vertices_to_run": [
    ]
}

Build Flow

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
  • "vertices_to_run": [
    ]
}

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

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
query Parameters
Stop Component Id (string) or Stop Component Id (null) (Stop Component Id)
Start Component Id (string) or Start Component Id (null) (Start Component Id)
log_builds
boolean (Log Builds)
Default: true
Flow Name (string) or Flow Name (null) (Flow Name)
event_delivery
string (EventDeliveryType)
Default: "polling"
Enum: "streaming" "direct" "polling"
Request Body schema: application/json
InputValueRequest (object) or null
FlowDataRequest (object) or null
Array of Files (strings) or Files (null) (Files)

Responses

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Simplified Run Flow

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
context (dict | None): Optional context to pass to the flow
http_request (Request): The incoming HTTP request for extracting global variables

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
- Extracts global variables from HTTP headers with prefix X-LANGFLOW-GLOBAL-VAR-*
- Merges extracted variables with the context parameter as "request_variables"
- In streaming mode, uses EventManager to handle events:
- "add_message": New messages during execution
- "token": Individual tokens during streaming
- "end": Final execution result

-
Authorizations:
API key queryAPI key header
path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
stream
boolean (Stream)
Default: false
User Id (string) or User Id (string) or User Id (null) (User Id)
Request Body schema: application/json
SimplifiedAPIRequest (object) or null
Context (object) or Context (null) (Context)

Responses

Response samples

Content type
application/json
null

Simplified Run Flow

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

+
Authorizations:
API key queryAPI key header
path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
stream
boolean (Stream)
Default: false
User Id (string) or User Id (string) or User Id (null) (User Id)
Request Body schema: application/json
Any of
Input Value (string) or Input Value (null) (Input Value)

The input value

+
Input Type (string) or Input Type (null) (Input Type)
Default: "chat"

The input type

+
Output Type (string) or Output Type (null) (Output Type)
Default: "chat"

The output type

+
Output Component (string) or Output Component (null) (Output Component)
Default: ""

If there are multiple output components, you can specify the component to get the output from.

+
Tweaks (object) or null

The tweaks

+
Session Id (string) or Session Id (null) (Session Id)

The session id

+

Responses

Request samples

Content type
application/json
{
  • "input_request": {
    },
  • "context": { }
}

Response samples

Content type
application/json
null

Webhook Run Flow

Run a flow using a webhook request.

Args:
flow_id_or_name (str): The flow ID or endpoint name.
flow (Flow): The flow to be executed.
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.

+

Request samples

Content type
application/json
Example
{
  • "input_value": "string",
  • "input_type": "chat",
  • "output_type": "chat",
  • "output_component": "",
  • "tweaks": {
    },
  • "session_id": "string"
}

Response samples

Content type
application/json
null

Webhook Run Flow

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.

path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
User Id (string) or User Id (string) or User Id (null) (User Id)

Responses

Responses

Response samples

Content type
application/json
{
  • "feature_flags": {
    },
  • "serialization_max_items_length": 0,
  • "serialization_max_text_length": 0,
  • "frontend_timeout": 0,
  • "auto_saving": true,
  • "auto_saving_interval": 0,
  • "health_check_max_retries": 0,
  • "max_file_size_upload": 0,
  • "webhook_polling_interval": 0,
  • "public_flow_cleanup_interval": 0,
  • "public_flow_expiration": 0,
  • "event_delivery": "polling",
  • "webhook_auth_enable": true,
  • "voice_mode_available": true,
  • "default_folder_name": "string",
  • "hide_getting_started_progress": true
}

Validate

Post Validate Code

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
code
required
string (Code)

Responses

Response samples

Content type
application/json
{
  • "feature_flags": {
    },
  • "serialization_max_items_length": 0,
  • "serialization_max_text_length": 0,
  • "frontend_timeout": 0,
  • "auto_saving": true,
  • "auto_saving_interval": 0,
  • "health_check_max_retries": 0,
  • "max_file_size_upload": 0,
  • "webhook_polling_interval": 0,
  • "public_flow_cleanup_interval": 0,
  • "public_flow_expiration": 0,
  • "event_delivery": "polling",
  • "voice_mode_available": true
}

Validate

Post Validate Code

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
code
required
string (Code)

Responses

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Users

Add User

Response samples

Content type
application/json
[
  • {
    }
]

Users

Add User

Add a new user to the database.

Request Body schema: application/json
required
username
required
string (Username)
password
required
string (Password)
Optins (object) or Optins (null) (Optins)
Default: {"github_starred":false,"dialog_dismissed":false,"discord_clicked":false}

Responses

Langflow (1.6.4)

Download OpenAPI specification:Download

Chat

Retrieve Vertices Order Deprecated

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.

-
path Parameters
flow_id
required
string <uuid> (Flow Id)
query Parameters
Stop Component Id (string) or Stop Component Id (null) (Stop Component Id)
Start Component Id (string) or Start Component Id (null) (Start Component Id)
Request Body schema: application/json
Any of
nodes
required
Array of objects (Nodes)
edges
required
Array of objects (Edges)
Viewport (object) or Viewport (null) (Viewport)

Responses

Request samples

Content type
application/json
Example
{
  • "nodes": [
    ],
  • "edges": [
    ],
  • "viewport": { }
}

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
  • "vertices_to_run": [
    ]
}

Build Flow

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
  • "vertices_to_run": [
    ]
}

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

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
query Parameters
Stop Component Id (string) or Stop Component Id (null) (Stop Component Id)
Start Component Id (string) or Start Component Id (null) (Start Component Id)
log_builds
boolean (Log Builds)
Default: true
Flow Name (string) or Flow Name (null) (Flow Name)
event_delivery
string (EventDeliveryType)
Default: "polling"
Enum: "streaming" "direct" "polling"
Request Body schema: application/json
InputValueRequest (object) or null
FlowDataRequest (object) or null
Array of Files (strings) or Files (null) (Files)

Responses

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Simplified Run Flow

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
context (dict | None): Optional context to pass to the flow
http_request (Request): The incoming HTTP request for extracting global variables

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
- Extracts global variables from HTTP headers with prefix X-LANGFLOW-GLOBAL-VAR-*
- Merges extracted variables with the context parameter as "request_variables"
- In streaming mode, uses EventManager to handle events:
- "add_message": New messages during execution
- "token": Individual tokens during streaming
- "end": Final execution result

-
Authorizations:
API key queryAPI key header
path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
stream
boolean (Stream)
Default: false
User Id (string) or User Id (string) or User Id (null) (User Id)
Request Body schema: application/json
SimplifiedAPIRequest (object) or null
Context (object) or Context (null) (Context)

Responses

Response samples

Content type
application/json
null

Simplified Run Flow

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

+
Authorizations:
API key queryAPI key header
path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
stream
boolean (Stream)
Default: false
User Id (string) or User Id (string) or User Id (null) (User Id)
Request Body schema: application/json
Any of
Input Value (string) or Input Value (null) (Input Value)

The input value

+
Input Type (string) or Input Type (null) (Input Type)
Default: "chat"

The input type

+
Output Type (string) or Output Type (null) (Output Type)
Default: "chat"

The output type

+
Output Component (string) or Output Component (null) (Output Component)
Default: ""

If there are multiple output components, you can specify the component to get the output from.

+
Tweaks (object) or null

The tweaks

+
Session Id (string) or Session Id (null) (Session Id)

The session id

+

Responses

Request samples

Content type
application/json
{
  • "input_request": {
    },
  • "context": { }
}

Response samples

Content type
application/json
null

Webhook Run Flow

Run a flow using a webhook request.

Args:
flow_id_or_name (str): The flow ID or endpoint name.
flow (Flow): The flow to be executed.
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.

+

Request samples

Content type
application/json
Example
{
  • "input_value": "string",
  • "input_type": "chat",
  • "output_type": "chat",
  • "output_component": "",
  • "tweaks": {
    },
  • "session_id": "string"
}

Response samples

Content type
application/json
null

Webhook Run Flow

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.

path Parameters
flow_id_or_name
required
string (Flow Id Or Name)
query Parameters
User Id (string) or User Id (string) or User Id (null) (User Id)

Responses

Responses

Response samples

Content type
application/json
{
  • "feature_flags": {
    },
  • "serialization_max_items_length": 0,
  • "serialization_max_text_length": 0,
  • "frontend_timeout": 0,
  • "auto_saving": true,
  • "auto_saving_interval": 0,
  • "health_check_max_retries": 0,
  • "max_file_size_upload": 0,
  • "webhook_polling_interval": 0,
  • "public_flow_cleanup_interval": 0,
  • "public_flow_expiration": 0,
  • "event_delivery": "polling",
  • "webhook_auth_enable": true,
  • "voice_mode_available": true,
  • "default_folder_name": "string",
  • "hide_getting_started_progress": true
}

Validate

Post Validate Code

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
code
required
string (Code)

Responses

Response samples

Content type
application/json
{
  • "feature_flags": {
    },
  • "serialization_max_items_length": 0,
  • "serialization_max_text_length": 0,
  • "frontend_timeout": 0,
  • "auto_saving": true,
  • "auto_saving_interval": 0,
  • "health_check_max_retries": 0,
  • "max_file_size_upload": 0,
  • "webhook_polling_interval": 0,
  • "public_flow_cleanup_interval": 0,
  • "public_flow_expiration": 0,
  • "event_delivery": "polling",
  • "voice_mode_available": true
}

Validate

Post Validate Code

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
code
required
string (Code)

Responses

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Users

Add User

Response samples

Content type
application/json
[
  • {
    }
]

Users

Add User

Add a new user to the database.

Request Body schema: application/json
required
username
required
string (Username)
password
required
string (Password)
Optins (object) or Optins (null) (Optins)
Default: {"github_starred":false,"dialog_dismissed":false,"discord_clicked":false}

Responses