diff --git a/404.html b/404.html index cff96d0b81..bf0a0e739c 100644 --- a/404.html +++ b/404.html @@ -24,8 +24,8 @@ - - + + diff --git a/agent-tutorial.html b/agent-tutorial.html index 056111772b..c68606716b 100644 --- a/agent-tutorial.html +++ b/agent-tutorial.html @@ -24,8 +24,8 @@ - - + + diff --git a/agents-tools.html b/agents-tools.html index 92ffe87118..9e6f550c03 100644 --- a/agents-tools.html +++ b/agents-tools.html @@ -24,8 +24,8 @@ - - + + diff --git a/agents.html b/agents.html index f9034422e1..6f30e776e2 100644 --- a/agents.html +++ b/agents.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-build.html b/api-build.html index f93efb30aa..beb3efb165 100644 --- a/api-build.html +++ b/api-build.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-files.html b/api-files.html index 4223289e5b..b72527132b 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 ab24e882c7..93da002d8a 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 2ef15a5d01..43649f3f07 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 8ea4291feb..ca87330bb5 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 14c98a68f0..7c403d3221 100644 --- a/api-logs.html +++ b/api-logs.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-monitor.html b/api-monitor.html index 3ce066e9de..7418b3a0a7 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 ee81c766cc..e64e0b6fdb 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 d98efe7670..85c380e7ef 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 76e23f9f44..893f3f99f3 100644 --- a/api-reference-api-examples.html +++ b/api-reference-api-examples.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-request.html b/api-request.html index 9c16db97e3..58aa0a8ec0 100644 --- a/api-request.html +++ b/api-request.html @@ -24,8 +24,8 @@ - - + + diff --git a/api-users.html b/api-users.html index 279823452d..f37f115519 100644 --- a/api-users.html +++ b/api-users.html @@ -24,8 +24,8 @@ - - + + diff --git a/api.html b/api.html index 274ee81820..381df123e5 100644 --- a/api.html +++ b/api.html @@ -24,8 +24,8 @@ - - + + @@ -65,6 +65,7 @@ html:not([data-theme='dark']) .jFZnBC:before{content:'';width:15px;height:15px;b html:not([data-theme='dark']) h1:hover>.jFZnBC::before,html:not([data-theme='dark']) h2:hover>.jFZnBC::before,html:not([data-theme='dark']) .jFZnBC:hover::before{visibility:visible;}/*!sc*/ html:not([data-theme='dark']) data-styled.g14[id="sc-kcLKEh"]{content:"jFZnBC,"}/*!sc*/ html:not([data-theme='dark']) .kdyvlj{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ +html:not([data-theme='dark']) .iIDFjm{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ html:not([data-theme='dark']) .ihtenX{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ html:not([data-theme='dark']) .jrzhZR{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ html:not([data-theme='dark']) .jrzhZR polygon{fill:#1d8127;}/*!sc*/ @@ -72,9 +73,8 @@ html:not([data-theme='dark']) .jiwddp{height:1.5em;width:1.5em;min-width:1.5em;v html:not([data-theme='dark']) .jiwddp polygon{fill:#d41f1c;}/*!sc*/ html:not([data-theme='dark']) .gmfplF{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/ html:not([data-theme='dark']) .gmfplF polygon{fill:white;}/*!sc*/ -html:not([data-theme='dark']) .iIDFjm{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ html:not([data-theme='dark']) .buALsp{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/ -html:not([data-theme='dark']) data-styled.g15[id="sc-dntSTA"]{content:"kdyvlj,ihtenX,jrzhZR,jiwddp,gmfplF,iIDFjm,buALsp,"}/*!sc*/ +html:not([data-theme='dark']) data-styled.g15[id="sc-dntSTA"]{content:"kdyvlj,iIDFjm,ihtenX,jrzhZR,jiwddp,gmfplF,buALsp,"}/*!sc*/ html:not([data-theme='dark']) .fHNmpI{display:inline-block;padding:2px 8px;margin:0;background-color:#ffa500;color:#ffffff;font-size:13px;vertical-align:middle;line-height:1.6;border-radius:4px;font-weight:var(--ifm-font-weight-bold);font-size:12px;}/*!sc*/ html:not([data-theme='dark']) .fHNmpI +span[type]{margin-left:4px;}/*!sc*/ html:not([data-theme='dark']) data-styled.g16[id="sc-kvnevz"]{content:"fHNmpI,"}/*!sc*/ @@ -313,6 +313,8 @@ html:not([data-theme='dark']) .IbfEc{color:#666;word-break:break-word;}/*!sc*/ html:not([data-theme='dark']) data-styled.g61[id="sc-hdBJTi"]{content:"IbfEc,"}/*!sc*/ html:not([data-theme='dark']) .gZffex{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/ html:not([data-theme='dark']) data-styled.g62[id="sc-iIvHqT"]{content:"gZffex,"}/*!sc*/ +html:not([data-theme='dark']) .hgFppI{color:#b68dfd;}/*!sc*/ +html:not([data-theme='dark']) data-styled.g63[id="sc-jxOwhs"]{content:"hgFppI,"}/*!sc*/ html:not([data-theme='dark']) .gEROs{border-radius:2px;word-break:break-word;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:var(--ifm-font-family-monospace);}/*!sc*/ html:not([data-theme='dark']) +{margin-left:0;}/*!sc*/ html:not([data-theme='dark']) data-styled.g66[id="sc-dTWiOz"]{content:"gEROs,"}/*!sc*/ @@ -491,6 +493,7 @@ html([data-theme='dark']) .jFZnBC:before{content:'';width:15px;height:15px;backg html([data-theme='dark']) h1:hover>.jFZnBC::before,html([data-theme='dark']) h2:hover>.jFZnBC::before,html([data-theme='dark']) .jFZnBC:hover::before{visibility:visible;}/*!sc*/ html([data-theme='dark']) data-styled.g14[id="sc-kcLKEh"]{content:"jFZnBC,"}/*!sc*/ html([data-theme='dark']) .kdyvlj{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ +html([data-theme='dark']) .iIDFjm{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ html([data-theme='dark']) .ihtenX{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ html([data-theme='dark']) .jrzhZR{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ html([data-theme='dark']) .jrzhZR polygon{fill:#1d8127;}/*!sc*/ @@ -498,9 +501,8 @@ html([data-theme='dark']) .jiwddp{height:1.5em;width:1.5em;min-width:1.5em;verti html([data-theme='dark']) .jiwddp polygon{fill:#d41f1c;}/*!sc*/ html([data-theme='dark']) .gmfplF{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/ html([data-theme='dark']) .gmfplF polygon{fill:white;}/*!sc*/ -html([data-theme='dark']) .iIDFjm{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ html([data-theme='dark']) .buALsp{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/ -html([data-theme='dark']) data-styled.g15[id="sc-dntSTA"]{content:"kdyvlj,ihtenX,jrzhZR,jiwddp,gmfplF,iIDFjm,buALsp,"}/*!sc*/ +html([data-theme='dark']) data-styled.g15[id="sc-dntSTA"]{content:"kdyvlj,iIDFjm,ihtenX,jrzhZR,jiwddp,gmfplF,buALsp,"}/*!sc*/ html([data-theme='dark']) .fHNmpI{display:inline-block;padding:2px 8px;margin:0;background-color:#ffa500;color:#ffffff;font-size:13px;vertical-align:middle;line-height:1.6;border-radius:4px;font-weight:var(--ifm-font-weight-bold);font-size:12px;}/*!sc*/ html([data-theme='dark']) .fHNmpI +span[type]{margin-left:4px;}/*!sc*/ html([data-theme='dark']) data-styled.g16[id="sc-kvnevz"]{content:"fHNmpI,"}/*!sc*/ @@ -739,6 +741,8 @@ html([data-theme='dark']) .bMkQtR{color:rgba(255, 255, 255, 1);word-break:break- html([data-theme='dark']) data-styled.g61[id="sc-hdBJTi"]{content:"bMkQtR,"}/*!sc*/ html([data-theme='dark']) .gZffex{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/ html([data-theme='dark']) data-styled.g62[id="sc-iIvHqT"]{content:"gZffex,"}/*!sc*/ +html([data-theme='dark']) .hgFppI{color:#b68dfd;}/*!sc*/ +html([data-theme='dark']) data-styled.g63[id="sc-jxOwhs"]{content:"hgFppI,"}/*!sc*/ html([data-theme='dark']) .dzwTLa{border-radius:2px;word-break:break-word;background-color:rgba(245,246,247,0.05);color:rgba(245,246,247,0.9);padding:0 5px;border:1px solid rgba(245,246,247,0.1);font-family:var(--ifm-font-family-monospace);}/*!sc*/ html([data-theme='dark']) +{margin-left:0;}/*!sc*/ html([data-theme='dark']) data-styled.g66[id="sc-dTWiOz"]{content:"dzwTLa,"}/*!sc*/ @@ -883,7 +887,7 @@ html([data-theme='dark']) data-styled.g137[id="sc-lhsSio"]{content:"bjjLSh,"}/*! html([data-theme='dark']) .fdfgWT{position:absolute;left:20px;height:1.8em;width:0.9em;}/*!sc*/ html([data-theme='dark']) .fdfgWT path{fill:#f5f6f7;}/*!sc*/ html([data-theme='dark']) data-styled.g138[id="sc-enPhjR"]{content:"fdfgWT,"}/*!sc*/ -

Langflow (1.7.0)

Download OpenAPI specification:Download

Chat

Retrieve Vertices Order Deprecated

Langflow (1.7.1)

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

required
Array of objects (Nodes)
required
Array of objects (Edges)
Viewport (object) or Viewport (null) (Viewport)

Responses

Request samples

Content type
application/json
{
  • "inputs": {
    },
  • "data": {
    },
  • "files": [
    ]
}

Response samples

Content type
application/json
null

Get Build Events

Get events for a specific build job.

-
path Parameters
job_id
required
string (Job Id)
query Parameters
event_delivery
string (EventDeliveryType)
Default: "streaming"
Enum: "streaming" "direct" "polling"

Responses

Request samples

Content type
application/json
{
  • "inputs": {
    },
  • "data": {
    },
  • "files": [
    ]
}

Response samples

Content type
application/json
null

Get Build Events

Get events for a specific build job.

Requires authentication to prevent unauthorized access to build events.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
job_id
required
string (Job Id)
query Parameters
event_delivery
string (EventDeliveryType)
Default: "streaming"
Enum: "streaming" "direct" "polling"

Responses

Response samples

Content type
application/json
null

Cancel Build

Cancel a specific build job.

-
path Parameters
job_id
required
string (Job Id)

Responses

Response samples

Content type
application/json
null

Cancel Build

Cancel a specific build job.

Requires authentication to prevent unauthorized build cancellation.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
job_id
required
string (Job Id)

Responses

Request samples

Content type
application/json
{
  • "inputs": {
    },
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "inactivated_vertices": [
    ],
  • "next_vertices_ids": [
    ],
  • "top_level_vertices": [
    ],
  • "valid": true,
  • "params": { },
  • "data": { },
  • "timestamp": "2019-08-24T14:15:22Z"
}

Build Vertex Stream Deprecated

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.

-
path Parameters
flow_id
required
string <uuid> (Flow Id)
vertex_id
required
string (Vertex Id)

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
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

Response samples

Content type
application/json
null

Simplified Run Flow

Executes a specified flow by ID with support for streaming and telemetry (API key auth).

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.
This endpoint uses API key authentication (Bearer token).

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
- Authentication: Requires API key (Bearer token)

+
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

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.

+

Request samples

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

Response samples

Content type
application/json
null

Simplified Run Flow Session

Executes a specified flow by ID with support for streaming and telemetry (session auth).

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.
This endpoint uses session-based authentication (cookies).

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 (User): Authenticated user from session
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
- Authentication: Requires active session (cookies)
- Feature Flag: Only available when agentic_experience is enabled

+
Authorizations:
OAuth2PasswordBearerAPI 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

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.

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

Response samples

Content type
application/json
{ }

Experimental Run Flow

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.

-
Authorizations:
API key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)
Request Body schema: application/json
Array of Inputs (objects) or Inputs (null) (Inputs)
Array of Outputs (strings) or Outputs (null) (Outputs)
Tweaks (object) or null
stream
boolean (Stream)
Default: false
Session Id (string) or Session Id (null) (Session Id)

Responses

Response samples

Content type
application/json
{ }

Experimental Run Flow

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 (Flow): The flow object to be executed, resolved via dependency injection.
- 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.

+
Authorizations:
API key queryAPI key header
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)
Request Body schema: application/json
Array of Inputs (objects) or Inputs (null) (Inputs)
Array of Outputs (strings) or Outputs (null) (Outputs)
Tweaks (object) or null
stream
boolean (Stream)
Default: false
Session Id (string) or Session Id (null) (Session Id)

Responses

Request samples

Content type
application/json
{
  • "inputs": [
    ],
  • "outputs": [
    ],
  • "tweaks": {
    },
  • "stream": false,
  • "session_id": "string"
}

Response samples

Content type
application/json
{
  • "outputs": [ ],
  • "session_id": "string"
}

Process

Request samples

Content type
application/json
{
  • "inputs": [
    ],
  • "outputs": [
    ],
  • "tweaks": {
    },
  • "stream": false,
  • "session_id": "string"
}

Response samples

Content type
application/json
{
  • "outputs": [ ],
  • "session_id": "string"
}

Process

Endpoint to process an input with a given flow_id.

Authorizations:
API key queryAPI key header
path Parameters
_flow_id
required
any ( Flow Id)

Responses

Response samples

Content type
application/json
null

Process

Response samples

Content type
application/json
null

Process

Endpoint to process an input with a given flow_id.

Authorizations:
API key queryAPI key header
path Parameters
_flow_id
required
any ( Flow Id)

Responses

Response samples

Content type
application/json
null

Get Task Status Deprecated

Response samples

Content type
application/json
null

Get Task Status Deprecated

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

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

path Parameters
_task_id
required
string ( Task Id)

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "result": { }
}

Create Upload File Deprecated

Response samples

Content type
application/json
{
  • "status": "string",
  • "result": { }
}

Create Upload File Deprecated

Upload a file for a specific flow (Deprecated).

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

path Parameters
flow_id
required
string <uuid> (Flow Id)
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "flowId": "string",
  • "file_path": "string"
}

Get Version

Responses

Response samples

Content type
application/json
{
  • "flowId": "string",
  • "file_path": "string"
}

Get Version

Responses

Response samples

Content type
application/json
null

Custom Component

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
code
required
string (Code)
Frontend Node (object) or Frontend Node (null) (Frontend Node)

Responses

Response samples

Content type
application/json
null

Custom Component

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
code
required
string (Code)
Frontend Node (object) or Frontend Node (null) (Frontend Node)

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "frontend_node": { }
}

Response samples

Content type
application/json
{
  • "data": { },
  • "type": "string"
}

Custom Component Update

Request samples

Content type
application/json
{
  • "code": "string",
  • "frontend_node": { }
}

Response samples

Content type
application/json
{
  • "data": { },
  • "type": "string"
}

Custom Component Update

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.

-
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
code
required
string (Code)
Frontend Node (object) or Frontend Node (null) (Frontend Node)
field
required
string (Field)
Field Value (string) or Field Value (integer) or Field Value (number) or Field Value (boolean) or Field Value (object) or Array of Field Value (any) or Field Value (null) (Field Value)
template
required
object (Template)
tool_mode
boolean (Tool Mode)
Default: false

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "frontend_node": { },
  • "field": "string",
  • "field_value": "string",
  • "template": { },
  • "tool_mode": false
}

Response samples

Content type
application/json
null

Get Config

Retrieve the current application configuration settings.

Returns:
ConfigResponse: The configuration settings of the application.

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

-

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "frontend_node": { },
  • "field": "string",
  • "field_value": "string",
  • "template": { },
  • "tool_mode": false
}

Response samples

Content type
application/json
null

Get Config

Retrieve the current application configuration settings.

Requires authentication to prevent exposure of sensitive configuration details.

Returns:
ConfigResponse: The configuration settings of the application.

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

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

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

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

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "imports": { },
  • "function": { }
}

Post Validate Prompt

Request Body schema: application/json
required
name
required
string (Name)
template
required
string (Template)
Custom Fields (object) or Custom Fields (null) (Custom Fields)
FrontendNodeRequest (object) or null

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "imports": { },
  • "function": { }
}

Post Validate Prompt

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
name
required
string (Name)
template
required
string (Template)
Custom Fields (object) or Custom Fields (null) (Custom Fields)
FrontendNodeRequest (object) or null

Responses

Response samples

Content type
application/json
null

Check If Store Has Api Key

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Share Component

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
name
required
string (Name)
required
Description (string) or Description (null) (Description)
data
required
object (Data)
required
Array of Tags (strings) or Tags (null) (Tags)
Parent (string) or Parent (null) (Parent)
required
Is Component (boolean) or Is Component (null) (Is Component)
Last Tested Version (string) or Last Tested Version (null) (Last Tested Version)
Private (boolean) or Private (null) (Private)
Default: true

Responses

Response samples

Content type
application/json
null

Share Component

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
name
required
string (Name)
required
Description (string) or Description (null) (Description)
required
object (Data)
required
Array of Tags (strings) or Tags (null) (Tags)
Parent (string) or Parent (null) (Parent)
required
Is Component (boolean) or Is Component (null) (Is Component)
Last Tested Version (string) or Last Tested Version (null) (Last Tested Version)
Private (boolean) or Private (null) (Private)
Default: true

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "authorized": true,
  • "results": [
    ]
}

Update Shared Component

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
component_id
required
string <uuid> (Component Id)
Request Body schema: application/json
required
name
required
string (Name)
required
Description (string) or Description (null) (Description)
data
required
object (Data)
required
Array of Tags (strings) or Tags (null) (Tags)
Parent (string) or Parent (null) (Parent)
required
Is Component (boolean) or Is Component (null) (Is Component)
Last Tested Version (string) or Last Tested Version (null) (Last Tested Version)
Private (boolean) or Private (null) (Private)
Default: true

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "authorized": true,
  • "results": [
    ]
}

Update Shared Component

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
component_id
required
string <uuid> (Component Id)
Request Body schema: application/json
required
name
required
string (Name)
required
Description (string) or Description (null) (Description)
required
object (Data)
required
Array of Tags (strings) or Tags (null) (Tags)
Parent (string) or Parent (null) (Parent)
required
Is Component (boolean) or Is Component (null) (Is Component)
Last Tested Version (string) or Last Tested Version (null) (Last Tested Version)
Private (boolean) or Private (null) (Private)
Default: true

Responses

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

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

Response samples

Content type
application/json
[
  • {
    }
]

Users

Add User

Add a new user to the database.

Requires superuser authentication to prevent unauthorized account creation.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
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

Response samples

Content type
application/json
{
  • "flowId": "string",
  • "file_path": "string"
}

Download File

path Parameters
file_name
required
string (File Name)
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
{
  • "flowId": "string",
  • "file_path": "string"
}

Download File

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
file_name
required
string (File Name)
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
null

Download Image

path Parameters
file_name
required
string (File Name)
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
null

Download Image

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
file_name
required
string (File Name)
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
null

Download Profile Picture

path Parameters
folder_name
required
string (Folder Name)
file_name
required
string (File Name)

Responses

Response samples

Content type
application/json
null

Download Profile Picture

Download profile picture from local filesystem.

Profile pictures are first looked up in config_dir/profile_pictures/,
then fallback to the package's bundled profile_pictures directory.

+
path Parameters
folder_name
required
string (Folder Name)
file_name
required
string (File Name)

Responses

Response samples

Content type
application/json
null

List Profile Pictures

Responses

Response samples

Content type
application/json
null

List Profile Pictures

List profile pictures from local filesystem.

Profile pictures are first looked up in config_dir/profile_pictures/,
then fallback to the package's bundled profile_pictures directory.

+

Responses

Response samples

Content type
application/json
null

List Files

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
null

List Files

List the files available to the current user.

-
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload User File

Response samples

Content type
application/json
null

Upload User File

Upload a file for the current user and track it in the database.

-
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "provider": "string"
}

Delete All Files

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "provider": "string"
}

List Files

List the files available to the current user.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete All Files

Delete all files for the current user.

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

List Files

List the files available to the current user.

-
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload User File

Response samples

Content type
application/json
null

Upload User File

Upload a file for the current user and track it in the database.

-
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "provider": "string"
}

Delete All Files

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "provider": "string"
}

List Files

List the files available to the current user.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete All Files

Delete all files for the current user.

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Monitor

Get Vertex Builds

query Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
null

Monitor

Get Vertex Builds

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
{
  • "vertex_builds": {
    }
}

Delete Vertex Builds

query Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
{
  • "vertex_builds": {
    }
}

Delete Vertex Builds

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
flow_id
required
string <uuid> (Flow Id)

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get Messages

query Parameters
Flow Id (string) or Flow Id (null) (Flow Id)
Session Id (string) or Session Id (null) (Session Id)
Sender (string) or Sender (null) (Sender)
Sender Name (string) or Sender Name (null) (Sender Name)
Order By (string) or Order By (null) (Order By)
Default: "timestamp"

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get Messages

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
Flow Id (string) or Flow Id (null) (Flow Id)
Session Id (string) or Session Id (null) (Session Id)
Sender (string) or Sender (null) (Sender)
Sender Name (string) or Sender Name (null) (Sender Name)
Order By (string) or Order By (null) (Order By)
Default: "timestamp"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Messages

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
Array
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Messages

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Update Message

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
message_id
required
string <uuid> (Message Id)
Request Body schema: application/json
required
Text (string) or Text (null) (Text)
Sender (string) or Sender (null) (Sender)
Sender Name (string) or Sender Name (null) (Sender Name)
Session Id (string) or Session Id (null) (Session Id)
Array of Files (strings) or Files (null) (Files)
Edit (boolean) or Edit (null) (Edit)
Error (boolean) or Error (null) (Error)
Properties (object) or null

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Update Message

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
message_id
required
string <uuid> (Message Id)
Request Body schema: application/json
required
Text (string) or Text (null) (Text)
Sender (string) or Sender (null) (Sender)
Sender Name (string) or Sender Name (null) (Sender Name)
Session Id (string) or Session Id (null) (Session Id)
Context Id (string) or Context Id (null) (Context Id)
Array of Files (strings) or Files (null) (Files)
Edit (boolean) or Edit (null) (Edit)
Error (boolean) or Error (null) (Error)
Properties (object) or null

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "sender": "string",
  • "sender_name": "string",
  • "session_id": "string",
  • "files": [
    ],
  • "edit": true,
  • "error": true,
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "sender": "string",
  • "sender_name": "string",
  • "session_id": "string",
  • "text": "string",
  • "files": [
    ],
  • "error": false,
  • "edit": false,
  • "properties": {
    },
  • "category": "message",
  • "content_blocks": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2"
}

Update Session Id

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
old_session_id
required
string (Old Session Id)
query Parameters
new_session_id
required
string (New Session Id)

Request samples

Content type
application/json
{
  • "text": "string",
  • "sender": "string",
  • "sender_name": "string",
  • "session_id": "string",
  • "context_id": "string",
  • "files": [
    ],
  • "edit": true,
  • "error": true,
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "sender": "string",
  • "sender_name": "string",
  • "session_id": "string",
  • "context_id": "string",
  • "text": "string",
  • "files": [
    ],
  • "error": false,
  • "edit": false,
  • "properties": {
    },
  • "category": "message",
  • "content_blocks": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2"
}

Update Session Id

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
old_session_id
required
string (Old Session Id)
query Parameters
new_session_id
required
string (New Session Id)

The new session ID to update to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Messages Session

path Parameters
session_id
required
string (Session Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Messages Session

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
session_id
required
string (Session Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Transactions

query Parameters
flow_id
required
string <uuid> (Flow Id)
page
integer (Page) >= 1
Default: 1

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Transactions

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
flow_id
required
string <uuid> (Flow Id)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 100 ]
Default: 50

Page size

@@ -1461,21 +1463,69 @@ html([data-theme='dark']) data-styled.g138[id="sc-enPhjR"]{content:"fdfgWT,"}/*! " class="sc-eVqvcJ sc-fszimp sc-etsjJW gvxaTx dmtfed eEseFw">

Successful Response

Handle Messages

Responses

Response samples

Content type
application/json
null

Handle Sse

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Sse

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Messages

Responses

Response samples

Content type
application/json
null

Voice

Get Elevenlabs Voice Ids

Response samples

Content type
application/json
null

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Handle Streamable Http

Streamable HTTP endpoint for MCP clients that support the new transport.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Voice

Get Elevenlabs Voice Ids

Get available voice IDs from ElevenLabs API.

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

mcp_projects

List Project Tools

List all tools in a project that are enabled for MCP.

+

Response samples

Content type
application/json
null

mcp_projects

List Project Tools

List project MCP tools.

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
project_id
required
string <uuid> (Project Id)
query Parameters
mcp_enabled
boolean (Mcp Enabled)
Default: true

Responses

Response samples

Content type
application/json
Example
{
  • "tools": [
    ],
  • "auth_settings": {
    }
}

Handle Project Messages

Response samples

Content type
application/json
null

Handle Project Messages

Handle POST messages for a project-specific MCP server.

path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Handle Project Messages With Slash

Handle POST messages for a project-specific MCP server with trailing slash.

+

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Handle Project Messages

Handle POST messages for a project-specific MCP server.

path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
null

Install Mcp Config

Install MCP server configuration for Cursor, Windsurf, or Claude.

-
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
project_id
required
string <uuid> (Project Id)
Request Body schema: application/json
required
client
required
string (Client)

Responses

Response samples

Content type
application/json
null

Handle Project Streamable Http

Handle Streamable HTTP connections for a specific project.

+
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Request samples

Content type
application/json
{
  • "client": "string"
}

Response samples

Content type
application/json
null

Get Project Composer Url

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Handle Project Streamable Http

Handle Streamable HTTP connections for a specific project.

+
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Handle Project Streamable Http

Handle Streamable HTTP connections for a specific project.

+
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Handle Project Streamable Http

Handle Streamable HTTP connections for a specific project.

+
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Handle Project Streamable Http

Handle Streamable HTTP connections for a specific project.

+
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Handle Project Streamable Http

Handle Streamable HTTP connections for a specific project.

+
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Install Mcp Config

Install MCP server configuration for Cursor, Windsurf, or Claude.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
project_id
required
string <uuid> (Project Id)
Request Body schema: application/json
required
client
required
string (Client)
Transport (string) or Transport (null) (Transport)

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "transport": "sse"
}

Response samples

Content type
application/json
null

Get Project Composer Url

Get the MCP Composer URL for a specific project.

On failure, this endpoint should return with a 200 status code and an error message in
the body of the response to display to the user.

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
null

Check Installed Mcp Servers

Response samples

Content type
application/json
{
  • "project_id": "string",
  • "uses_composer": true,
  • "streamable_http_url": "string",
  • "legacy_sse_url": "string",
  • "error_message": "string"
}

Check Installed Mcp Servers

Check if MCP server configuration is installed for this project in Cursor, Windsurf, or Claude.

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
null

OpenAI Responses API

Create Response

Response samples

Content type
application/json
null

OpenAI Responses API

Create Response

Create a response using OpenAI Responses API format.

This endpoint accepts a flow_id in the model parameter and processes
the input through the specified Langflow flow.

Args:
request: OpenAI Responses API request with model (flow_id) and input
background_tasks: FastAPI background task manager
api_key_user: Authenticated user from API key
http_request: The incoming HTTP request
telemetry_service: Telemetry service for logging

Returns:
OpenAI-compatible response or streaming response

Raises:
HTTPException: For validation errors or flow execution issues

Authorizations:
API key queryAPI key header
Request Body schema: application/json
required
model
required
string (Model)

The flow ID to execute (used instead of OpenAI model)

@@ -1549,11 +1635,11 @@ html([data-theme='dark']) data-styled.g138[id="sc-enPhjR"]{content:"fdfgWT,"}/*! " class="sc-eVqvcJ sc-fszimp sc-etsjJW gvxaTx dmtfed eEseFw">

Successful Response

Response samples

Content type
application/json
null

Add Server

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
server_name
required
string (Server Name)
Request Body schema: application/json
required
object (Server Config)

Responses

Response samples

Content type
application/json
null

Add Server

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
server_name
required
string (Server Name)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Update Server Endpoint

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
server_name
required
string (Server Name)
Request Body schema: application/json
required
object (Server Config)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Update Server Endpoint

Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
server_name
required
string (Server Name)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Response samples

Content type
application/json
null

Health Check

Health

Responses

Response samples

Content type
application/json
null

Registration API

Get Registration

Get the registered user (if any).

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Health Check

Responses

Response samples

Content type
application/json
null

Register User

Register the single user with email.

Note: Only one registration is allowed.

+
Request Body schema: application/json
required
email
required
string <email> (Email)

Responses

Response samples

Content type
application/json
{
  • "status": "nok",
  • "chat": "error check the server logs",
  • "db": "error check the server logs"
}

Log

Stream Logs

HTTP/2 Server-Sent-Event (SSE) endpoint for streaming logs.

It establishes a long-lived connection to the server and receives log messages in real-time.
The client should use the header "Accept: text/event-stream".

-

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "email": "string"
}

Health Check

Health

Responses

Response samples

Content type
application/json
null

Logs

query Parameters
lines_before
integer (Lines Before)
Default: 0

Response samples

Content type
application/json
null

Health Check

Responses

Response samples

Content type
application/json
{
  • "status": "nok",
  • "chat": "error check the server logs",
  • "db": "error check the server logs"
}

Log

Stream Logs

HTTP/2 Server-Sent-Event (SSE) endpoint for streaming logs.

Requires authentication to prevent exposure of sensitive log data.
It establishes a long-lived connection to the server and receives log messages in real-time.
The client should use the header "Accept: text/event-stream".

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header

Responses

Response samples

Content type
application/json
null

Logs

Retrieve application logs with authentication required.

SECURITY: Logs may contain sensitive information and require authentication.

+
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
lines_before
integer (Lines Before)
Default: 0

The number of logs before the timestamp or the last log

lines_after
integer (Lines After)
Default: 0

The number of logs after the timestamp

@@ -1579,7 +1677,7 @@ html([data-theme='dark']) data-styled.g138[id="sc-enPhjR"]{content:"fdfgWT,"}/*! " class="sc-eVqvcJ sc-fszimp sc-etsjJW gvxaTx dmtfed eEseFw">

Successful Response

Response samples

Content type
application/json
null