diff --git a/docs/openapi/openapi.json b/docs/openapi/openapi.json
index 75957225a1c5..bd85c7f2df6d 100644
--- a/docs/openapi/openapi.json
+++ b/docs/openapi/openapi.json
@@ -2,9 +2,114 @@
"openapi": "3.1.0",
"info": {
"title": "Langflow",
- "version": "1.8.0"
+ "version": "1.7.3"
},
"paths": {
+ "/api/v1/build/{flow_id}/vertices": {
+ "post": {
+ "tags": [
+ "Chat"
+ ],
+ "summary": "Retrieve Vertices Order",
+ "description": "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.",
+ "operationId": "retrieve_vertices_order_api_v1_build__flow_id__vertices_post",
+ "deprecated": true,
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "flow_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Flow Id"
+ }
+ },
+ {
+ "name": "stop_component_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Stop Component Id"
+ }
+ },
+ {
+ "name": "start_component_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Start Component Id"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/FlowDataRequest"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Data"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VerticesOrderResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/api/v1/build/{flow_id}/flow": {
"post": {
"tags": [
@@ -15,7 +120,7 @@
"operationId": "build_flow_api_v1_build__flow_id__flow_post",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -144,7 +249,7 @@
"operationId": "get_build_events_api_v1_build__job_id__events_get",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -205,7 +310,7 @@
"operationId": "cancel_build_api_v1_build__job_id__cancel_post",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -249,6 +354,138 @@
}
}
},
+ "/api/v1/build/{flow_id}/vertices/{vertex_id}": {
+ "post": {
+ "tags": [
+ "Chat"
+ ],
+ "summary": "Build Vertex",
+ "description": "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.",
+ "operationId": "build_vertex_api_v1_build__flow_id__vertices__vertex_id__post",
+ "deprecated": true,
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "flow_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Flow Id"
+ }
+ },
+ {
+ "name": "vertex_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Vertex Id"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_build_vertex_api_v1_build__flow_id__vertices__vertex_id__post"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VertexBuildResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/build/{flow_id}/{vertex_id}/stream": {
+ "get": {
+ "tags": [
+ "Chat"
+ ],
+ "summary": "Build Vertex Stream",
+ "description": "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.",
+ "operationId": "build_vertex_stream_api_v1_build__flow_id___vertex_id__stream_get",
+ "deprecated": true,
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "flow_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Flow Id"
+ }
+ },
+ {
+ "name": "vertex_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Vertex Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/api/v1/build_public_tmp/{flow_id}/flow": {
"post": {
"tags": [
@@ -394,7 +631,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -493,14 +730,25 @@
}
}
},
- "/api/v1/webhook/{flow_id_or_name}": {
+ "/api/v1/run/session/{flow_id_or_name}": {
"post": {
"tags": [
"Base"
],
- "summary": "Webhook Run Flow",
- "description": "Run a flow using a webhook request.
Args:
flow_id_or_name: The flow ID or endpoint name (used by dependency).
flow: The flow to be executed.
request: The incoming HTTP request.
Returns:
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.",
- "operationId": "webhook_run_flow_api_v1_webhook__flow_id_or_name__post",
+ "summary": "Simplified Run Flow Session",
+ "description": "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",
+ "operationId": "simplified_run_flow_session_api_v1_run_session__flow_id_or_name__post",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
"parameters": [
{
"name": "flow_id_or_name",
@@ -511,6 +759,16 @@
"title": "Flow Id Or Name"
}
},
+ {
+ "name": "stream",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Stream"
+ }
+ },
{
"name": "user_id",
"in": "query",
@@ -532,16 +790,21 @@
}
}
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_simplified_run_flow_session_api_v1_run_session__flow_id_or_name__post"
+ }
+ }
+ }
+ },
"responses": {
- "202": {
+ "200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "type": "object",
- "additionalProperties": true,
- "title": "Response Webhook Run Flow Api V1 Webhook Flow Id Or Name Post"
- }
+ "schema": {}
}
}
},
@@ -558,23 +821,15 @@
}
}
},
- "/api/v1/run/advanced/{flow_id_or_name}": {
+ "/api/v1/webhook/{flow_id_or_name}": {
"post": {
"tags": [
"Base"
],
- "summary": "Experimental Run Flow",
- "description": "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
POST /run/flow_id
x-api-key: YOUR_API_KEY
Payload:
{
\"inputs\": [
{\"components\": [\"component1\"], \"input_value\": \"value1\"},
{\"components\": [\"component3\"], \"input_value\": \"value2\"}
],
\"outputs\": [\"Component Name\", \"component_id\"],
\"tweaks\": {\"parameter_name\": \"value\", \"Component Name\": {\"parameter_name\": \"value\"}, \"component_id\": {\"parameter_name\": \"value\"}}
\"stream\": false
}
```
This endpoint facilitates complex flow executions with customized inputs, outputs, and configurations,
catering to diverse application requirements.",
- "operationId": "experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post",
- "security": [
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ],
- "parameters": [
+ "summary": "Webhook Run Flow",
+ "description": "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.",
+ "operationId": "webhook_run_flow_api_v1_webhook__flow_id_or_name__post",
+ "parameters": [
{
"name": "flow_id_or_name",
"in": "path",
@@ -605,22 +860,15 @@
}
}
],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Body_experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post"
- }
- }
- }
- },
"responses": {
- "200": {
+ "202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RunResponse"
+ "type": "object",
+ "additionalProperties": true,
+ "title": "Response Webhook Run Flow Api V1 Webhook Flow Id Or Name Post"
}
}
}
@@ -638,93 +886,69 @@
}
}
},
- "/api/v1/version": {
- "get": {
- "tags": [
- "Base"
- ],
- "summary": "Get Version",
- "operationId": "get_version_api_v1_version_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/api/v1/config": {
- "get": {
+ "/api/v1/run/advanced/{flow_id_or_name}": {
+ "post": {
"tags": [
"Base"
],
- "summary": "Get Config",
- "description": "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.",
- "operationId": "get_config_api_v1_config_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ConfigResponse"
- }
- }
- }
- }
- },
+ "summary": "Experimental Run Flow",
+ "description": "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
POST /run/flow_id
x-api-key: YOUR_API_KEY
Payload:
{
\"inputs\": [
{\"components\": [\"component1\"], \"input_value\": \"value1\"},
{\"components\": [\"component3\"], \"input_value\": \"value2\"}
],
\"outputs\": [\"Component Name\", \"component_id\"],
\"tweaks\": {\"parameter_name\": \"value\", \"Component Name\": {\"parameter_name\": \"value\"}, \"component_id\": {\"parameter_name\": \"value\"}}
\"stream\": false
}
```
This endpoint facilitates complex flow executions with customized inputs, outputs, and configurations,
catering to diverse application requirements.",
+ "operationId": "experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post",
"security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
{
"API key query": []
},
{
"API key header": []
}
- ]
- }
- },
- "/api/v1/flows/": {
- "post": {
- "tags": [
- "Flows"
],
- "summary": "Create Flow",
- "operationId": "create_flow_api_v1_flows__post",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
+ "parameters": [
{
- "API key query": []
+ "name": "flow_id_or_name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Flow Id Or Name"
+ }
},
{
- "API key header": []
+ "name": "user_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "User Id"
+ }
}
],
"requestBody": {
- "required": true,
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/FlowCreate"
+ "$ref": "#/components/schemas/Body_experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post"
}
}
}
},
"responses": {
- "201": {
+ "200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/FlowRead"
+ "$ref": "#/components/schemas/RunResponse"
}
}
}
@@ -740,18 +964,17 @@
}
}
}
- },
- "get": {
+ }
+ },
+ "/api/v1/process/{_flow_id}": {
+ "post": {
"tags": [
- "Flows"
+ "Base"
],
- "summary": "Read Flows",
- "description": "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.",
- "operationId": "read_flows_api_v1_flows__get",
+ "summary": "Process",
+ "description": "Endpoint to process an input with a given flow_id.",
+ "operationId": "process_api_v1_process___flow_id__post",
"security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
{
"API key query": []
},
@@ -761,83 +984,11 @@
],
"parameters": [
{
- "name": "remove_example_flows",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false,
- "title": "Remove Example Flows"
- }
- },
- {
- "name": "components_only",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false,
- "title": "Components Only"
- }
- },
- {
- "name": "get_all",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": true,
- "title": "Get All"
- }
- },
- {
- "name": "folder_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Folder Id"
- }
- },
- {
- "name": "header_flows",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false,
- "title": "Header Flows"
- }
- },
- {
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 1,
- "default": 1,
- "title": "Page"
- }
- },
- {
- "name": "size",
- "in": "query",
- "required": false,
+ "name": "_flow_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "default": 50,
- "title": "Size"
+ "title": " Flow Id"
}
}
],
@@ -846,26 +997,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FlowRead"
- }
- },
- {
- "$ref": "#/components/schemas/Page_FlowRead_"
- },
- {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FlowHeader"
- }
- }
- ],
- "title": "Response Read Flows Api V1 Flows Get"
- }
+ "schema": {}
}
}
},
@@ -880,18 +1012,17 @@
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/predict/{_flow_id}": {
+ "post": {
"tags": [
- "Flows"
+ "Base"
],
- "summary": "Delete Multiple Flows",
- "description": "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.",
- "operationId": "delete_multiple_flows_api_v1_flows__delete",
+ "summary": "Process",
+ "description": "Endpoint to process an input with a given flow_id.",
+ "operationId": "process_api_v1_predict___flow_id__post",
"security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
{
"API key query": []
},
@@ -899,21 +1030,16 @@
"API key header": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "title": "Flow Ids"
- }
+ "parameters": [
+ {
+ "name": "_flow_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "title": " Flow Id"
}
}
- },
+ ],
"responses": {
"200": {
"description": "Successful Response",
@@ -936,34 +1062,23 @@
}
}
},
- "/api/v1/flows/{flow_id}": {
+ "/api/v1/task/{_task_id}": {
"get": {
"tags": [
- "Flows"
- ],
- "summary": "Read Flow",
- "description": "Read a flow.",
- "operationId": "read_flow_api_v1_flows__flow_id__get",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
+ "Base"
],
+ "summary": "Get Task Status",
+ "description": "Get the status of a task by ID (Deprecated).
This endpoint is deprecated and will be removed in a future version.",
+ "operationId": "get_task_status_api_v1_task___task_id__get",
+ "deprecated": true,
"parameters": [
{
- "name": "flow_id",
+ "name": "_task_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "format": "uuid",
- "title": "Flow Id"
+ "title": " Task Id"
}
}
],
@@ -973,7 +1088,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/FlowRead"
+ "$ref": "#/components/schemas/TaskStatusResponse"
}
}
}
@@ -989,25 +1104,17 @@
}
}
}
- },
- "patch": {
+ }
+ },
+ "/api/v1/upload/{flow_id}": {
+ "post": {
"tags": [
- "Flows"
- ],
- "summary": "Update Flow",
- "description": "Update a flow.",
- "operationId": "update_flow_api_v1_flows__flow_id__patch",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
+ "Base"
],
+ "summary": "Create Upload File",
+ "description": "Upload a file for a specific flow (Deprecated).
This endpoint is deprecated and will be removed in a future version.",
+ "operationId": "create_upload_file_api_v1_upload__flow_id__post",
+ "deprecated": true,
"parameters": [
{
"name": "flow_id",
@@ -1023,20 +1130,20 @@
"requestBody": {
"required": true,
"content": {
- "application/json": {
+ "multipart/form-data": {
"schema": {
- "$ref": "#/components/schemas/FlowUpdate"
+ "$ref": "#/components/schemas/Body_create_upload_file_api_v1_upload__flow_id__post"
}
}
}
},
"responses": {
- "200": {
+ "201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/FlowRead"
+ "$ref": "#/components/schemas/UploadFileResponse"
}
}
}
@@ -1052,37 +1159,15 @@
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/version": {
+ "get": {
"tags": [
- "Flows"
- ],
- "summary": "Delete Flow",
- "description": "Delete a flow.",
- "operationId": "delete_flow_api_v1_flows__flow_id__delete",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ],
- "parameters": [
- {
- "name": "flow_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Flow Id"
- }
- }
+ "Base"
],
+ "summary": "Get Version",
+ "operationId": "get_version_api_v1_version_get",
"responses": {
"200": {
"description": "Successful Response",
@@ -1091,47 +1176,34 @@
"schema": {}
}
}
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
}
}
}
},
- "/api/v1/flows/public_flow/{flow_id}": {
- "get": {
+ "/api/v1/custom_component": {
+ "post": {
"tags": [
- "Flows"
+ "Base"
],
- "summary": "Read Public Flow",
- "description": "Read a public flow.",
- "operationId": "read_public_flow_api_v1_flows_public_flow__flow_id__get",
- "parameters": [
- {
- "name": "flow_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Flow Id"
+ "summary": "Custom Component",
+ "operationId": "custom_component_api_v1_custom_component_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CustomComponentRequest"
+ }
}
- }
- ],
+ },
+ "required": true
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/FlowRead"
+ "$ref": "#/components/schemas/CustomComponentResponse"
}
}
}
@@ -1146,39 +1218,44 @@
}
}
}
- }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
}
},
- "/api/v1/flows/batch/": {
+ "/api/v1/custom_component/update": {
"post": {
"tags": [
- "Flows"
+ "Base"
],
- "summary": "Create Flows",
- "description": "Create multiple new flows.",
- "operationId": "create_flows_api_v1_flows_batch__post",
+ "summary": "Custom Component Update",
+ "description": "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.",
+ "operationId": "custom_component_update_api_v1_custom_component_update_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/FlowListCreate"
+ "$ref": "#/components/schemas/UpdateCustomComponentRequest"
}
}
},
"required": true
},
"responses": {
- "201": {
+ "200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/FlowRead"
- },
- "type": "array",
- "title": "Response Create Flows Api V1 Flows Batch Post"
- }
+ "schema": {}
}
}
},
@@ -1195,7 +1272,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -1206,17 +1283,29 @@
]
}
},
- "/api/v1/flows/upload/": {
- "post": {
+ "/api/v1/config": {
+ "get": {
"tags": [
- "Flows"
+ "Base"
],
- "summary": "Upload File",
- "description": "Upload flows from a file.",
- "operationId": "upload_file_api_v1_flows_upload__post",
+ "summary": "Get Config",
+ "description": "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.",
+ "operationId": "get_config_api_v1_config_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ConfigResponse"
+ }
+ }
+ }
+ }
+ },
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -1224,47 +1313,33 @@
{
"API key header": []
}
+ ]
+ }
+ },
+ "/api/v1/validate/code": {
+ "post": {
+ "tags": [
+ "Validate"
],
- "parameters": [
- {
- "name": "folder_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Folder Id"
- }
- }
- ],
+ "summary": "Post Validate Code",
+ "operationId": "post_validate_code_api_v1_validate_code_post",
"requestBody": {
- "required": true,
"content": {
- "multipart/form-data": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/Body_upload_file_api_v1_flows_upload__post"
+ "$ref": "#/components/schemas/Code"
}
}
- }
+ },
+ "required": true
},
"responses": {
- "201": {
+ "200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FlowRead"
- },
- "title": "Response Upload File Api V1 Flows Upload Post"
+ "$ref": "#/components/schemas/CodeValidationResponse"
}
}
}
@@ -1279,27 +1354,32 @@
}
}
}
- }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
}
},
- "/api/v1/flows/download/": {
+ "/api/v1/validate/prompt": {
"post": {
"tags": [
- "Flows"
+ "Validate"
],
- "summary": "Download Multiple File",
- "description": "Download all flows as a zip file.",
- "operationId": "download_multiple_file_api_v1_flows_download__post",
+ "summary": "Post Validate Prompt",
+ "operationId": "post_validate_prompt_api_v1_validate_prompt_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "type": "array",
- "title": "Flow Ids"
+ "$ref": "#/components/schemas/ValidatePromptRequest"
}
}
},
@@ -1310,7 +1390,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/PromptValidationResponse"
+ }
}
}
},
@@ -1327,7 +1409,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -1338,46 +1420,79 @@
]
}
},
- "/api/v1/flows/basic_examples/": {
+ "/api/v1/store/check/": {
"get": {
"tags": [
- "Flows"
+ "Components Store"
],
- "summary": "Read Basic Examples",
- "description": "Retrieve a list of basic example flows.
Args:
session (Session): The database session.
Returns:
list[FlowRead]: A list of basic example flows.",
- "operationId": "read_basic_examples_api_v1_flows_basic_examples__get",
+ "summary": "Check If Store Is Enabled",
+ "operationId": "check_if_store_is_enabled_api_v1_store_check__get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/FlowRead"
- },
- "type": "array",
- "title": "Response Read Basic Examples Api V1 Flows Basic Examples Get"
- }
+ "schema": {}
}
}
}
}
}
},
- "/api/v1/users/": {
- "post": {
+ "/api/v1/store/check/api_key": {
+ "get": {
"tags": [
- "Users"
+ "Components Store"
],
- "summary": "Add User",
- "description": "Add a new user to the database.
This endpoint allows public user registration (sign up).
User activation is controlled by the NEW_USER_IS_ACTIVE setting.",
- "operationId": "add_user_api_v1_users__post",
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
+ "summary": "Check If Store Has Api Key",
+ "operationId": "check_if_store_has_api_key_api_v1_store_check_api_key_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ }
+ },
+ "/api/v1/store/components/": {
+ "post": {
+ "tags": [
+ "Components Store"
+ ],
+ "summary": "Share Component",
+ "operationId": "share_component_api_v1_store_components__post",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/UserCreate"
+ "$ref": "#/components/schemas/StoreComponentCreate"
}
}
}
@@ -1388,7 +1503,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UserRead"
+ "$ref": "#/components/schemas/CreateComponentResponse"
}
}
}
@@ -1407,14 +1522,13 @@
},
"get": {
"tags": [
- "Users"
+ "Components Store"
],
- "summary": "Read All Users",
- "description": "Retrieve a list of users from the database with pagination.",
- "operationId": "read_all_users_api_v1_users__get",
+ "summary": "Get Components",
+ "operationId": "get_components_api_v1_store_components__get",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -1425,13 +1539,154 @@
],
"parameters": [
{
- "name": "skip",
+ "name": "component_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Component Id"
+ }
+ },
+ {
+ "name": "search",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Search"
+ }
+ },
+ {
+ "name": "private",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Private"
+ }
+ },
+ {
+ "name": "is_component",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Is Component"
+ }
+ },
+ {
+ "name": "tags",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Tags"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sort"
+ }
+ },
+ {
+ "name": "liked",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Liked"
+ }
+ },
+ {
+ "name": "filter_by_user",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Filter By User"
+ }
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Fields"
+ }
+ },
+ {
+ "name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
- "default": 0,
- "title": "Skip"
+ "default": 1,
+ "title": "Page"
}
},
{
@@ -1451,7 +1706,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UsersResponse"
+ "$ref": "#/components/schemas/ListComponentResponseModel"
}
}
}
@@ -1469,50 +1724,16 @@
}
}
},
- "/api/v1/users/whoami": {
- "get": {
- "tags": [
- "Users"
- ],
- "summary": "Read Current User",
- "description": "Retrieve the current user's data.",
- "operationId": "read_current_user_api_v1_users_whoami_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UserRead"
- }
- }
- }
- }
- },
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ]
- }
- },
- "/api/v1/users/{user_id}": {
+ "/api/v1/store/components/{component_id}": {
"patch": {
"tags": [
- "Users"
+ "Components Store"
],
- "summary": "Patch User",
- "description": "Update an existing user's data.",
- "operationId": "patch_user_api_v1_users__user_id__patch",
+ "summary": "Update Shared Component",
+ "operationId": "update_shared_component_api_v1_store_components__component_id__patch",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -1523,13 +1744,13 @@
],
"parameters": [
{
- "name": "user_id",
+ "name": "component_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "User Id"
+ "title": "Component Id"
}
}
],
@@ -1538,18 +1759,18 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UserUpdate"
+ "$ref": "#/components/schemas/StoreComponentCreate"
}
}
}
},
"responses": {
- "200": {
+ "201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UserRead"
+ "$ref": "#/components/schemas/CreateComponentResponse"
}
}
}
@@ -1566,16 +1787,15 @@
}
}
},
- "delete": {
+ "get": {
"tags": [
- "Users"
+ "Components Store"
],
- "summary": "Delete User",
- "description": "Delete a user from the database.",
- "operationId": "delete_user_api_v1_users__user_id__delete",
+ "summary": "Download Component",
+ "operationId": "download_component_api_v1_store_components__component_id__get",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -1586,13 +1806,13 @@
],
"parameters": [
{
- "name": "user_id",
+ "name": "component_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "User Id"
+ "title": "Component Id"
}
}
],
@@ -1602,9 +1822,7 @@
"content": {
"application/json": {
"schema": {
- "type": "object",
- "additionalProperties": true,
- "title": "Response Delete User Api V1 Users User Id Delete"
+ "$ref": "#/components/schemas/DownloadComponentResponse"
}
}
}
@@ -1622,81 +1840,77 @@
}
}
},
- "/api/v1/users/{user_id}/reset-password": {
- "patch": {
+ "/api/v1/store/tags": {
+ "get": {
"tags": [
- "Users"
- ],
- "summary": "Reset Password",
- "description": "Reset a user's password.",
- "operationId": "reset_password_api_v1_users__user_id__reset_password_patch",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
+ "Components Store"
],
- "parameters": [
- {
- "name": "user_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "User Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UserUpdate"
- }
- }
- }
- },
+ "summary": "Get Tags",
+ "operationId": "get_tags_api_v1_store_tags_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UserRead"
+ "items": {
+ "$ref": "#/components/schemas/TagResponse"
+ },
+ "type": "array",
+ "title": "Response Get Tags Api V1 Store Tags Get"
}
}
}
- },
- "422": {
- "description": "Validation Error",
+ }
+ }
+ }
+ },
+ "/api/v1/store/users/likes": {
+ "get": {
+ "tags": [
+ "Components Store"
+ ],
+ "summary": "Get List Of Components Liked By User",
+ "operationId": "get_list_of_components_liked_by_user_api_v1_store_users_likes_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "items": {
+ "$ref": "#/components/schemas/UsersLikesResponse"
+ },
+ "type": "array",
+ "title": "Response Get List Of Components Liked By User Api V1 Store Users Likes Get"
}
}
}
}
- }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
}
},
- "/api/v1/files/upload/{flow_id}": {
+ "/api/v1/store/users/likes/{component_id}": {
"post": {
"tags": [
- "Files"
+ "Components Store"
],
- "summary": "Upload File",
- "operationId": "upload_file_api_v1_files_upload__flow_id__post",
+ "summary": "Like Component",
+ "operationId": "like_component_api_v1_store_users_likes__component_id__post",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -1707,33 +1921,23 @@
],
"parameters": [
{
- "name": "flow_id",
+ "name": "component_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Flow Id"
+ "title": "Component Id"
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "multipart/form-data": {
- "schema": {
- "$ref": "#/components/schemas/Body_upload_file_api_v1_files_upload__flow_id__post"
- }
- }
- }
- },
"responses": {
- "201": {
+ "200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/langflow__api__v1__schemas__UploadFileResponse"
+ "$ref": "#/components/schemas/UsersLikesResponse"
}
}
}
@@ -1751,16 +1955,16 @@
}
}
},
- "/api/v1/files/download/{flow_id}/{file_name}": {
- "get": {
+ "/api/v1/flows/": {
+ "post": {
"tags": [
- "Files"
+ "Flows"
],
- "summary": "Download File",
- "operationId": "download_file_api_v1_files_download__flow_id___file_name__get",
+ "summary": "Create Flow",
+ "operationId": "create_flow_api_v1_flows__post",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -1769,33 +1973,24 @@
"API key header": []
}
],
- "parameters": [
- {
- "name": "file_name",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "File Name"
- }
- },
- {
- "name": "flow_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Flow Id"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FlowCreate"
+ }
}
}
- ],
+ },
"responses": {
- "200": {
+ "201": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/FlowRead"
+ }
}
}
},
@@ -1810,34 +2005,104 @@
}
}
}
- }
- },
- "/api/v1/files/images/{flow_id}/{file_name}": {
+ },
"get": {
"tags": [
- "Files"
+ "Flows"
+ ],
+ "summary": "Read Flows",
+ "description": "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.",
+ "operationId": "read_flows_api_v1_flows__get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
],
- "summary": "Download Image",
- "description": "Download image from storage for browser rendering.",
- "operationId": "download_image_api_v1_files_images__flow_id___file_name__get",
"parameters": [
{
- "name": "flow_id",
- "in": "path",
- "required": true,
+ "name": "remove_example_flows",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Flow Id"
+ "type": "boolean",
+ "default": false,
+ "title": "Remove Example Flows"
}
},
{
- "name": "file_name",
- "in": "path",
- "required": true,
+ "name": "components_only",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "title": "File Name"
+ "type": "boolean",
+ "default": false,
+ "title": "Components Only"
+ }
+ },
+ {
+ "name": "get_all",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": true,
+ "title": "Get All"
+ }
+ },
+ {
+ "name": "folder_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Folder Id"
+ }
+ },
+ {
+ "name": "header_flows",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Header Flows"
+ }
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "default": 1,
+ "title": "Page"
+ }
+ },
+ {
+ "name": "size",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 100,
+ "minimum": 1,
+ "default": 50,
+ "title": "Size"
}
}
],
@@ -1846,7 +2111,26 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FlowRead"
+ }
+ },
+ {
+ "$ref": "#/components/schemas/Page_FlowRead_"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FlowHeader"
+ }
+ }
+ ],
+ "title": "Response Read Flows Api V1 Flows Get"
+ }
}
}
},
@@ -1861,36 +2145,40 @@
}
}
}
- }
- },
- "/api/v1/files/profile_pictures/{folder_name}/{file_name}": {
- "get": {
+ },
+ "delete": {
"tags": [
- "Files"
+ "Flows"
],
- "summary": "Download Profile Picture",
- "description": "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.",
- "operationId": "download_profile_picture_api_v1_files_profile_pictures__folder_name___file_name__get",
- "parameters": [
+ "summary": "Delete Multiple Flows",
+ "description": "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.",
+ "operationId": "delete_multiple_flows_api_v1_flows__delete",
+ "security": [
{
- "name": "folder_name",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Folder Name"
- }
+ "OAuth2PasswordBearer": []
},
{
- "name": "file_name",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "File Name"
- }
+ "API key query": []
+ },
+ {
+ "API key header": []
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "title": "Flow Ids"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
@@ -1913,36 +2201,17 @@
}
}
},
- "/api/v1/files/profile_pictures/list": {
- "get": {
- "tags": [
- "Files"
- ],
- "summary": "List Profile Pictures",
- "description": "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.",
- "operationId": "list_profile_pictures_api_v1_files_profile_pictures_list_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/api/v1/files/list/{flow_id}": {
+ "/api/v1/flows/{flow_id}": {
"get": {
"tags": [
- "Files"
+ "Flows"
],
- "summary": "List Files",
- "operationId": "list_files_api_v1_files_list__flow_id__get",
+ "summary": "Read Flow",
+ "description": "Read a flow.",
+ "operationId": "read_flow_api_v1_flows__flow_id__get",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -1968,7 +2237,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/FlowRead"
+ }
}
}
},
@@ -1983,18 +2254,17 @@
}
}
}
- }
- },
- "/api/v1/files/delete/{flow_id}/{file_name}": {
- "delete": {
+ },
+ "patch": {
"tags": [
- "Files"
+ "Flows"
],
- "summary": "Delete File",
- "operationId": "delete_file_api_v1_files_delete__flow_id___file_name__delete",
+ "summary": "Update Flow",
+ "description": "Update a flow.",
+ "operationId": "update_flow_api_v1_flows__flow_id__patch",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2004,15 +2274,6 @@
}
],
"parameters": [
- {
- "name": "file_name",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "File Name"
- }
- },
{
"name": "flow_id",
"in": "path",
@@ -2024,12 +2285,24 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FlowUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/FlowRead"
+ }
}
}
},
@@ -2044,18 +2317,17 @@
}
}
}
- }
- },
- "/api/v1/monitor/builds": {
- "get": {
+ },
+ "delete": {
"tags": [
- "Monitor"
+ "Flows"
],
- "summary": "Get Vertex Builds",
- "operationId": "get_vertex_builds_api_v1_monitor_builds_get",
+ "summary": "Delete Flow",
+ "description": "Delete a flow.",
+ "operationId": "delete_flow_api_v1_flows__flow_id__delete",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2067,7 +2339,7 @@
"parameters": [
{
"name": "flow_id",
- "in": "query",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
@@ -2081,9 +2353,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/VertexBuildMapModel"
- }
+ "schema": {}
}
}
},
@@ -2098,28 +2368,20 @@
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/flows/public_flow/{flow_id}": {
+ "get": {
"tags": [
- "Monitor"
- ],
- "summary": "Delete Vertex Builds",
- "operationId": "delete_vertex_builds_api_v1_monitor_builds_delete",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
+ "Flows"
],
+ "summary": "Read Public Flow",
+ "description": "Read a public flow.",
+ "operationId": "read_public_flow_api_v1_flows_public_flow__flow_id__get",
"parameters": [
{
"name": "flow_id",
- "in": "query",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
@@ -2129,8 +2391,15 @@
}
],
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FlowRead"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -2145,16 +2414,74 @@
}
}
},
- "/api/v1/monitor/messages/sessions": {
- "get": {
+ "/api/v1/flows/batch/": {
+ "post": {
"tags": [
- "Monitor"
+ "Flows"
],
- "summary": "Get Message Sessions",
- "operationId": "get_message_sessions_api_v1_monitor_messages_sessions_get",
+ "summary": "Create Flows",
+ "description": "Create multiple new flows.",
+ "operationId": "create_flows_api_v1_flows_batch__post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FlowListCreate"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/FlowRead"
+ },
+ "type": "array",
+ "title": "Response Create Flows Api V1 Flows Batch Post"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ }
+ },
+ "/api/v1/flows/upload/": {
+ "post": {
+ "tags": [
+ "Flows"
+ ],
+ "summary": "Upload File",
+ "description": "Upload flows from a file.",
+ "operationId": "upload_file_api_v1_flows_upload__post",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2165,7 +2492,7 @@
],
"parameters": [
{
- "name": "flow_id",
+ "name": "folder_id",
"in": "query",
"required": false,
"schema": {
@@ -2178,21 +2505,31 @@
"type": "null"
}
],
- "title": "Flow Id"
+ "title": "Folder Id"
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_upload_file_api_v1_flows_upload__post"
+ }
+ }
+ }
+ },
"responses": {
- "200": {
+ "201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
- "type": "string"
+ "$ref": "#/components/schemas/FlowRead"
},
- "title": "Response Get Message Sessions Api V1 Monitor Messages Sessions Get"
+ "title": "Response Upload File Api V1 Flows Upload Post"
}
}
}
@@ -2210,120 +2547,35 @@
}
}
},
- "/api/v1/monitor/messages": {
- "get": {
+ "/api/v1/flows/download/": {
+ "post": {
"tags": [
- "Monitor"
+ "Flows"
],
- "summary": "Get Messages",
- "operationId": "get_messages_api_v1_monitor_messages_get",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ],
- "parameters": [
- {
- "name": "flow_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
+ "summary": "Download Multiple File",
+ "description": "Download all flows as a zip file.",
+ "operationId": "download_multiple_file_api_v1_flows_download__post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
"type": "string",
"format": "uuid"
},
- {
- "type": "null"
- }
- ],
- "title": "Flow Id"
- }
- },
- {
- "name": "session_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Session Id"
- }
- },
- {
- "name": "sender",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Sender"
- }
- },
- {
- "name": "sender_name",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Sender Name"
+ "type": "array",
+ "title": "Flow Ids"
+ }
}
},
- {
- "name": "order_by",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": "timestamp",
- "title": "Order By"
- }
- }
- ],
+ "required": true
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MessageResponse"
- },
- "title": "Response Get Messages Api V1 Monitor Messages Get"
- }
+ "schema": {}
}
}
},
@@ -2337,17 +2589,10 @@
}
}
}
- }
- },
- "delete": {
- "tags": [
- "Monitor"
- ],
- "summary": "Delete Messages",
- "operationId": "delete_messages_api_v1_monitor_messages_delete",
+ },
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2355,32 +2600,28 @@
{
"API key header": []
}
+ ]
+ }
+ },
+ "/api/v1/flows/basic_examples/": {
+ "get": {
+ "tags": [
+ "Flows"
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "title": "Message Ids"
- }
- }
- }
- },
+ "summary": "Read Basic Examples",
+ "description": "Retrieve a list of basic example flows.
Args:
session (Session): The database session.
Returns:
list[FlowRead]: A list of basic example flows.",
+ "operationId": "read_basic_examples_api_v1_flows_basic_examples__get",
"responses": {
- "204": {
- "description": "Successful Response"
- },
- "422": {
- "description": "Validation Error",
+ "200": {
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "items": {
+ "$ref": "#/components/schemas/FlowRead"
+ },
+ "type": "array",
+ "title": "Response Read Basic Examples Api V1 Flows Basic Examples Get"
}
}
}
@@ -2388,16 +2629,17 @@
}
}
},
- "/api/v1/monitor/messages/{message_id}": {
- "put": {
+ "/api/v1/users/": {
+ "post": {
"tags": [
- "Monitor"
+ "Users"
],
- "summary": "Update Message",
- "operationId": "update_message_api_v1_monitor_messages__message_id__put",
+ "summary": "Add User",
+ "description": "Add a new user to the database.
Requires superuser authentication to prevent unauthorized account creation.",
+ "operationId": "add_user_api_v1_users__post",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2406,35 +2648,23 @@
"API key header": []
}
],
- "parameters": [
- {
- "name": "message_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Message Id"
- }
- }
- ],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MessageUpdate"
+ "$ref": "#/components/schemas/UserCreate"
}
}
}
},
"responses": {
- "200": {
+ "201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MessageRead"
+ "$ref": "#/components/schemas/UserRead"
}
}
}
@@ -2450,18 +2680,17 @@
}
}
}
- }
- },
- "/api/v1/monitor/messages/session/{old_session_id}": {
- "patch": {
+ },
+ "get": {
"tags": [
- "Monitor"
+ "Users"
],
- "summary": "Update Session Id",
- "operationId": "update_session_id_api_v1_monitor_messages_session__old_session_id__patch",
+ "summary": "Read All Users",
+ "description": "Retrieve a list of users from the database with pagination.",
+ "operationId": "read_all_users_api_v1_users__get",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2472,24 +2701,24 @@
],
"parameters": [
{
- "name": "old_session_id",
- "in": "path",
- "required": true,
+ "name": "skip",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "title": "Old Session Id"
+ "type": "integer",
+ "default": 0,
+ "title": "Skip"
}
},
{
- "name": "new_session_id",
+ "name": "limit",
"in": "query",
- "required": true,
+ "required": false,
"schema": {
- "type": "string",
- "description": "The new session ID to update to",
- "title": "New Session Id"
- },
- "description": "The new session ID to update to"
+ "type": "integer",
+ "default": 10,
+ "title": "Limit"
+ }
}
],
"responses": {
@@ -2498,11 +2727,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MessageResponse"
- },
- "title": "Response Update Session Id Api V1 Monitor Messages Session Old Session Id Patch"
+ "$ref": "#/components/schemas/UsersResponse"
}
}
}
@@ -2520,16 +2745,29 @@
}
}
},
- "/api/v1/monitor/messages/session/{session_id}": {
- "delete": {
+ "/api/v1/users/whoami": {
+ "get": {
"tags": [
- "Monitor"
+ "Users"
],
- "summary": "Delete Messages Session",
- "operationId": "delete_messages_session_api_v1_monitor_messages_session__session_id__delete",
+ "summary": "Read Current User",
+ "description": "Retrieve the current user's data.",
+ "operationId": "read_current_user_api_v1_users_whoami_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserRead"
+ }
+ }
+ }
+ }
+ },
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2537,21 +2775,60 @@
{
"API key header": []
}
+ ]
+ }
+ },
+ "/api/v1/users/{user_id}": {
+ "patch": {
+ "tags": [
+ "Users"
],
- "parameters": [
+ "summary": "Patch User",
+ "description": "Update an existing user's data.",
+ "operationId": "patch_user_api_v1_users__user_id__patch",
+ "security": [
{
- "name": "session_id",
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Session Id"
+ "format": "uuid",
+ "title": "User Id"
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserUpdate"
+ }
+ }
+ }
+ },
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserRead"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -2564,18 +2841,17 @@
}
}
}
- }
- },
- "/api/v1/monitor/transactions": {
- "get": {
+ },
+ "delete": {
"tags": [
- "Monitor"
+ "Users"
],
- "summary": "Get Transactions",
- "operationId": "get_transactions_api_v1_monitor_transactions_get",
+ "summary": "Delete User",
+ "description": "Delete a user from the database.",
+ "operationId": "delete_user_api_v1_users__user_id__delete",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2586,50 +2862,90 @@
],
"parameters": [
{
- "name": "flow_id",
- "in": "query",
+ "name": "user_id",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Flow Id"
+ "title": "User Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true,
+ "title": "Response Delete User Api V1 Users User Id Delete"
+ }
+ }
}
},
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/users/{user_id}/reset-password": {
+ "patch": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Reset Password",
+ "description": "Reset a user's password.",
+ "operationId": "reset_password_api_v1_users__user_id__reset_password_patch",
+ "security": [
{
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 1,
- "description": "Page number",
- "default": 1,
- "title": "Page"
- },
- "description": "Page number"
+ "OAuth2PasswordBearer": []
},
{
- "name": "size",
- "in": "query",
- "required": false,
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "user_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "maximum": 100,
- "minimum": 1,
- "description": "Page size",
- "default": 50,
- "title": "Size"
- },
- "description": "Page size"
+ "type": "string",
+ "format": "uuid",
+ "title": "User Id"
+ }
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Page_TransactionLogsResponse_"
+ "$ref": "#/components/schemas/UserRead"
}
}
}
@@ -2647,24 +2963,20 @@
}
}
},
- "/api/v1/projects/": {
+ "/api/v1/api_key/": {
"get": {
"tags": [
- "Projects"
+ "APIKey"
],
- "summary": "Read Projects",
- "operationId": "read_projects_api_v1_projects__get",
+ "summary": "Get Api Keys Route",
+ "operationId": "get_api_keys_route_api_v1_api_key__get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "items": {
- "$ref": "#/components/schemas/FolderRead"
- },
- "type": "array",
- "title": "Response Read Projects Api V1 Projects Get"
+ "$ref": "#/components/schemas/ApiKeysResponse"
}
}
}
@@ -2672,7 +2984,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2684,27 +2996,27 @@
},
"post": {
"tags": [
- "Projects"
+ "APIKey"
],
- "summary": "Create Project",
- "operationId": "create_project_api_v1_projects__post",
+ "summary": "Create Api Key Route",
+ "operationId": "create_api_key_route_api_v1_api_key__post",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/FolderCreate"
+ "$ref": "#/components/schemas/ApiKeyCreate"
}
}
},
"required": true
},
"responses": {
- "201": {
+ "200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/FolderRead"
+ "$ref": "#/components/schemas/UnmaskedApiKeyRead"
}
}
}
@@ -2722,7 +3034,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2733,16 +3045,16 @@
]
}
},
- "/api/v1/projects/{project_id}": {
- "get": {
+ "/api/v1/api_key/{api_key_id}": {
+ "delete": {
"tags": [
- "Projects"
+ "APIKey"
],
- "summary": "Read Project",
- "operationId": "read_project_api_v1_projects__project_id__get",
+ "summary": "Delete Api Key Route",
+ "operationId": "delete_api_key_route_api_v1_api_key__api_key_id__delete",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2753,75 +3065,13 @@
],
"parameters": [
{
- "name": "project_id",
+ "name": "api_key_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
- }
- },
- {
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Page"
- }
- },
- {
- "name": "size",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Size"
- }
- },
- {
- "name": "is_component",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false,
- "title": "Is Component"
- }
- },
- {
- "name": "is_flow",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false,
- "title": "Is Flow"
- }
- },
- {
- "name": "search",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "default": "",
- "title": "Search"
+ "title": "Api Key Id"
}
}
],
@@ -2830,17 +3080,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/FolderWithPaginatedFlows"
- },
- {
- "$ref": "#/components/schemas/FolderReadWithFlows"
- }
- ],
- "title": "Response Read Project Api V1 Projects Project Id Get"
- }
+ "schema": {}
}
}
},
@@ -2855,54 +3095,31 @@
}
}
}
- },
- "patch": {
+ }
+ },
+ "/api/v1/api_key/store": {
+ "post": {
"tags": [
- "Projects"
+ "APIKey"
],
- "summary": "Update Project",
- "operationId": "update_project_api_v1_projects__project_id__patch",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
+ "summary": "Save Store Api Key",
+ "operationId": "save_store_api_key_api_v1_api_key_store_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ApiKeyCreateRequest"
+ }
+ }
},
- {
- "API key header": []
- }
- ],
- "parameters": [
- {
- "name": "project_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/FolderUpdate"
- }
- }
- }
+ "required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/FolderRead"
- }
+ "schema": {}
}
}
},
@@ -2916,17 +3133,10 @@
}
}
}
- }
- },
- "delete": {
- "tags": [
- "Projects"
- ],
- "summary": "Delete Project",
- "operationId": "delete_project_api_v1_projects__project_id__delete",
+ },
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -2934,22 +3144,36 @@
{
"API key header": []
}
+ ]
+ }
+ },
+ "/api/v1/login": {
+ "post": {
+ "tags": [
+ "Login"
],
- "parameters": [
- {
- "name": "project_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "summary": "Login To Get Access Token",
+ "operationId": "login_to_get_access_token_api_v1_login_post",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_login_to_get_access_token_api_v1_login_post"
+ }
}
- }
- ],
+ },
+ "required": true
+ },
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Token"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -2964,37 +3188,13 @@
}
}
},
- "/api/v1/projects/download/{project_id}": {
+ "/api/v1/auto_login": {
"get": {
"tags": [
- "Projects"
- ],
- "summary": "Download File",
- "description": "Download all flows from project as a zip file.",
- "operationId": "download_file_api_v1_projects_download__project_id__get",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ],
- "parameters": [
- {
- "name": "project_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
- }
- }
+ "Login"
],
+ "summary": "Auto Login",
+ "operationId": "auto_login_api_v1_auto_login_get",
"responses": {
"200": {
"description": "Successful Response",
@@ -3003,59 +3203,67 @@
"schema": {}
}
}
- },
- "422": {
- "description": "Validation Error",
+ }
+ }
+ }
+ },
+ "/api/v1/refresh": {
+ "post": {
+ "tags": [
+ "Login"
+ ],
+ "summary": "Refresh Token",
+ "operationId": "refresh_token_api_v1_refresh_post",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
+ "schema": {}
}
}
}
}
}
},
- "/api/v1/projects/upload/": {
+ "/api/v1/logout": {
"post": {
"tags": [
- "Projects"
+ "Login"
],
- "summary": "Upload File",
- "description": "Upload flows from a file.",
- "operationId": "upload_file_api_v1_projects_upload__post",
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "$ref": "#/components/schemas/Body_upload_file_api_v1_projects_upload__post"
+ "summary": "Logout",
+ "operationId": "logout_api_v1_logout_post",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
}
}
- },
- "required": true
- },
+ }
+ }
+ }
+ },
+ "/api/v1/variables/": {
+ "get": {
+ "tags": [
+ "Variables"
+ ],
+ "summary": "Read Variables",
+ "description": "Read all variables.",
+ "operationId": "read_variables_api_v1_variables__get",
"responses": {
- "201": {
+ "200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
- "$ref": "#/components/schemas/FlowRead"
+ "$ref": "#/components/schemas/VariableRead"
},
"type": "array",
- "title": "Response Upload File Api V1 Projects Upload Post"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "title": "Response Read Variables Api V1 Variables Get"
}
}
}
@@ -3063,7 +3271,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -3072,27 +3280,41 @@
"API key header": []
}
]
- }
- },
- "/api/v1/starter-projects/": {
- "get": {
+ },
+ "post": {
"tags": [
- "Flows"
+ "Variables"
],
- "summary": "Get Starter Projects",
- "description": "Get a list of starter projects.",
- "operationId": "get_starter_projects_api_v1_starter_projects__get",
+ "summary": "Create Variable",
+ "description": "Create a new variable.",
+ "operationId": "create_variable_api_v1_variables__post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VariableCreate"
+ }
+ }
+ },
+ "required": true
+ },
"responses": {
- "200": {
+ "201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "items": {
- "$ref": "#/components/schemas/GraphDumpResponse"
- },
- "type": "array",
- "title": "Response Get Starter Projects Api V1 Starter Projects Get"
+ "$ref": "#/components/schemas/VariableRead"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
}
}
}
@@ -3100,7 +3322,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -3111,21 +3333,17 @@
]
}
},
- "/api/v1/mcp/sse": {
- "get": {
+ "/api/v1/variables/{variable_id}": {
+ "patch": {
"tags": [
- "mcp"
+ "Variables"
],
- "summary": "Handle Sse",
- "operationId": "handle_sse_api_v1_mcp_sse_get",
- "responses": {
- "200": {
- "description": "Successful Response"
- }
- },
+ "summary": "Update Variable",
+ "description": "Update a variable.",
+ "operationId": "update_variable_api_v1_variables__variable_id__patch",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -3133,63 +3351,62 @@
{
"API key header": []
}
- ]
- },
- "head": {
- "tags": [
- "mcp"
],
- "summary": "Im Alive",
- "operationId": "im_alive_api_v1_mcp_sse_head",
+ "parameters": [
+ {
+ "name": "variable_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Variable Id"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VariableUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
- "text/html": {
+ "application/json": {
"schema": {
- "type": "string"
+ "$ref": "#/components/schemas/VariableRead"
}
}
}
- }
- }
- }
- },
- "/api/v1/mcp/": {
- "post": {
- "tags": [
- "mcp"
- ],
- "summary": "Handle Messages",
- "operationId": "handle_messages_api_v1_mcp__post",
- "responses": {
- "200": {
- "description": "Successful Response",
+ },
+ "422": {
+ "description": "Validation Error",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
}
}
}
}
- }
- },
- "/api/v1/mcp/streamable": {
- "get": {
+ },
+ "delete": {
"tags": [
- "mcp"
+ "Variables"
],
- "summary": "Handle Streamable Http",
- "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_v1_mcp_streamable_post",
- "responses": {
- "200": {
- "description": "Successful Response"
- }
- },
+ "summary": "Delete Variable",
+ "description": "Delete a variable.",
+ "operationId": "delete_variable_api_v1_variables__variable_id__delete",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -3197,90 +3414,46 @@
{
"API key header": []
}
- ]
- },
- "post": {
- "tags": [
- "mcp"
],
- "summary": "Handle Streamable Http",
- "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_v1_mcp_streamable_post",
- "responses": {
- "200": {
- "description": "Successful Response"
- }
- },
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
+ "parameters": [
{
- "API key header": []
+ "name": "variable_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Variable Id"
+ }
}
- ]
- },
- "delete": {
- "tags": [
- "mcp"
],
- "summary": "Handle Streamable Http",
- "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_v1_mcp_streamable_post",
"responses": {
- "200": {
+ "204": {
"description": "Successful Response"
- }
- },
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
},
- {
- "API key header": []
- }
- ]
- },
- "head": {
- "tags": [
- "mcp"
- ],
- "summary": "Streamable Health",
- "operationId": "streamable_health_api_v1_mcp_streamable_head",
- "responses": {
- "200": {
- "description": "Successful Response",
+ "422": {
+ "description": "Validation Error",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
}
}
}
}
}
},
- "/api/v1/mcp/streamable/": {
- "get": {
+ "/api/v1/files/upload/{flow_id}": {
+ "post": {
"tags": [
- "mcp"
+ "Files"
],
- "summary": "Handle Streamable Http",
- "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_v1_mcp_streamable__post",
- "responses": {
- "200": {
- "description": "Successful Response"
- }
- },
+ "summary": "Upload File",
+ "operationId": "upload_file_api_v1_files_upload__flow_id__post",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -3288,68 +3461,63 @@
{
"API key header": []
}
- ]
- },
- "post": {
- "tags": [
- "mcp"
],
- "summary": "Handle Streamable Http",
- "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_v1_mcp_streamable__post",
- "responses": {
- "200": {
- "description": "Successful Response"
- }
- },
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
+ "parameters": [
{
- "API key header": []
+ "name": "flow_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Flow Id"
+ }
}
- ]
- },
- "delete": {
- "tags": [
- "mcp"
],
- "summary": "Handle Streamable Http",
- "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_v1_mcp_streamable__post",
- "responses": {
- "200": {
- "description": "Successful Response"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_upload_file_api_v1_files_upload__flow_id__post"
+ }
+ }
}
},
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
+ "responses": {
+ "201": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UploadFileResponse"
+ }
+ }
+ }
},
- {
- "API key header": []
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
}
- ]
+ }
}
},
- "/api/v1/mcp/project/{project_id}": {
+ "/api/v1/files/download/{flow_id}/{file_name}": {
"get": {
"tags": [
- "mcp_projects"
+ "Files"
],
- "summary": "List Project Tools",
- "description": "List project MCP tools.",
- "operationId": "list_project_tools_api_v1_mcp_project__project_id__get",
+ "summary": "Download File",
+ "operationId": "download_file_api_v1_files_download__flow_id___file_name__get",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -3360,23 +3528,22 @@
],
"parameters": [
{
- "name": "project_id",
+ "name": "file_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "title": "File Name"
}
},
{
- "name": "mcp_enabled",
- "in": "query",
- "required": false,
+ "name": "flow_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "boolean",
- "default": true,
- "title": "Mcp Enabled"
+ "type": "string",
+ "format": "uuid",
+ "title": "Flow Id"
}
}
],
@@ -3400,23 +3567,34 @@
}
}
}
- },
- "post": {
+ }
+ },
+ "/api/v1/files/images/{flow_id}/{file_name}": {
+ "get": {
"tags": [
- "mcp_projects"
+ "Files"
],
- "summary": "Handle Project Messages",
- "description": "Handle POST messages for a project-specific MCP server.",
- "operationId": "handle_project_messages_api_v1_mcp_project__project_id__post",
+ "summary": "Download Image",
+ "description": "Download image from storage for browser rendering.",
+ "operationId": "download_image_api_v1_files_images__flow_id___file_name__get",
"parameters": [
{
- "name": "project_id",
+ "name": "flow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
+ "title": "Flow Id"
+ }
+ },
+ {
+ "name": "file_name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "File Name"
}
}
],
@@ -3440,47 +3618,36 @@
}
}
}
- },
- "patch": {
+ }
+ },
+ "/api/v1/files/profile_pictures/{folder_name}/{file_name}": {
+ "get": {
"tags": [
- "mcp_projects"
+ "Files"
],
- "summary": "Update Project Mcp Settings",
- "description": "Update the MCP settings of all flows in a project and project-level auth settings.
On MCP Composer 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.",
- "operationId": "update_project_mcp_settings_api_v1_mcp_project__project_id__patch",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
+ "summary": "Download Profile Picture",
+ "description": "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.",
+ "operationId": "download_profile_picture_api_v1_files_profile_pictures__folder_name___file_name__get",
+ "parameters": [
{
- "API key query": []
+ "name": "folder_name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Folder Name"
+ }
},
{
- "API key header": []
- }
- ],
- "parameters": [
- {
- "name": "project_id",
+ "name": "file_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "title": "File Name"
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/MCPProjectUpdateRequest"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
@@ -3503,63 +3670,53 @@
}
}
},
- "/api/v1/mcp/project/{project_id}/sse": {
- "head": {
+ "/api/v1/files/profile_pictures/list": {
+ "get": {
"tags": [
- "mcp_projects"
- ],
- "summary": "Im Alive",
- "operationId": "im_alive_api_v1_mcp_project__project_id__sse_head",
- "parameters": [
- {
- "name": "project_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Project Id"
- }
- }
+ "Files"
],
+ "summary": "List Profile Pictures",
+ "description": "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.",
+ "operationId": "list_profile_pictures_api_v1_files_profile_pictures_list_get",
"responses": {
"200": {
"description": "Successful Response",
- "content": {
- "text/html": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
+ "schema": {}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/files/list/{flow_id}": {
"get": {
"tags": [
- "mcp_projects"
+ "Files"
+ ],
+ "summary": "List Files",
+ "operationId": "list_files_api_v1_files_list__flow_id__get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
],
- "summary": "Handle Project Sse",
- "description": "Handle SSE connections for a specific project.",
- "operationId": "handle_project_sse_api_v1_mcp_project__project_id__sse_get",
"parameters": [
{
- "name": "project_id",
+ "name": "flow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
+ "title": "Flow Id"
}
}
],
@@ -3567,10 +3724,8 @@
"200": {
"description": "Successful Response",
"content": {
- "text/html": {
- "schema": {
- "type": "string"
- }
+ "application/json": {
+ "schema": {}
}
}
},
@@ -3587,23 +3742,42 @@
}
}
},
- "/api/v1/mcp/project/{project_id}/": {
- "post": {
+ "/api/v1/files/delete/{flow_id}/{file_name}": {
+ "delete": {
"tags": [
- "mcp_projects"
+ "Files"
+ ],
+ "summary": "Delete File",
+ "operationId": "delete_file_api_v1_files_delete__flow_id___file_name__delete",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
],
- "summary": "Handle Project Messages",
- "description": "Handle POST messages for a project-specific MCP server.",
- "operationId": "handle_project_messages_api_v1_mcp_project__project_id___post",
"parameters": [
{
- "name": "project_id",
+ "name": "file_name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "File Name"
+ }
+ },
+ {
+ "name": "flow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
+ "title": "Flow Id"
}
}
],
@@ -3629,22 +3803,33 @@
}
}
},
- "/api/v1/mcp/project/{project_id}/streamable": {
- "head": {
+ "/api/v1/monitor/builds": {
+ "get": {
"tags": [
- "mcp_projects"
+ "Monitor"
+ ],
+ "summary": "Get Vertex Builds",
+ "operationId": "get_vertex_builds_api_v1_monitor_builds_get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
],
- "summary": "Streamable Health",
- "operationId": "streamable_health_api_v1_mcp_project__project_id__streamable_head",
"parameters": [
{
- "name": "project_id",
- "in": "path",
+ "name": "flow_id",
+ "in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
+ "title": "Flow Id"
}
}
],
@@ -3653,7 +3838,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/VertexBuildMapModel"
+ }
}
}
},
@@ -3669,27 +3856,37 @@
}
}
},
- "post": {
+ "delete": {
"tags": [
- "mcp_projects"
+ "Monitor"
+ ],
+ "summary": "Delete Vertex Builds",
+ "operationId": "delete_vertex_builds_api_v1_monitor_builds_delete",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
],
- "summary": "Handle Project Streamable Http",
- "description": "Handle Streamable HTTP connections for a specific project.",
- "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_post",
"parameters": [
{
- "name": "project_id",
- "in": "path",
+ "name": "flow_id",
+ "in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
+ "title": "Flow Id"
}
}
],
"responses": {
- "200": {
+ "204": {
"description": "Successful Response"
},
"422": {
@@ -3703,64 +3900,59 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/monitor/messages/sessions": {
"get": {
"tags": [
- "mcp_projects"
+ "Monitor"
+ ],
+ "summary": "Get Message Sessions",
+ "operationId": "get_message_sessions_api_v1_monitor_messages_sessions_get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
],
- "summary": "Handle Project Streamable Http",
- "description": "Handle Streamable HTTP connections for a specific project.",
- "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_post",
"parameters": [
{
- "name": "project_id",
- "in": "path",
- "required": true,
+ "name": "flow_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Flow Id"
}
}
],
"responses": {
"200": {
- "description": "Successful Response"
- },
- "422": {
- "description": "Validation Error",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "Response Get Message Sessions Api V1 Monitor Messages Sessions Get"
}
}
}
- }
- }
- },
- "delete": {
- "tags": [
- "mcp_projects"
- ],
- "summary": "Handle Project Streamable Http",
- "description": "Handle Streamable HTTP connections for a specific project.",
- "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_post",
- "parameters": [
- {
- "name": "project_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -3775,64 +3967,122 @@
}
}
},
- "/api/v1/mcp/project/{project_id}/streamable/": {
- "post": {
+ "/api/v1/monitor/messages": {
+ "get": {
"tags": [
- "mcp_projects"
+ "Monitor"
+ ],
+ "summary": "Get Messages",
+ "operationId": "get_messages_api_v1_monitor_messages_get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
],
- "summary": "Handle Project Streamable Http",
- "description": "Handle Streamable HTTP connections for a specific project.",
- "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable__post",
"parameters": [
{
- "name": "project_id",
- "in": "path",
- "required": true,
+ "name": "flow_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Flow Id"
}
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response"
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ {
+ "name": "session_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- }
+ ],
+ "title": "Session Id"
}
- }
- }
- },
- "get": {
- "tags": [
- "mcp_projects"
- ],
- "summary": "Handle Project Streamable Http",
- "description": "Handle Streamable HTTP connections for a specific project.",
- "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable__post",
- "parameters": [
+ },
{
- "name": "project_id",
- "in": "path",
- "required": true,
+ "name": "sender",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sender"
+ }
+ },
+ {
+ "name": "sender_name",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sender Name"
+ }
+ },
+ {
+ "name": "order_by",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": "timestamp",
+ "title": "Order By"
}
}
],
"responses": {
"200": {
- "description": "Successful Response"
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MessageResponse"
+ },
+ "title": "Response Get Messages Api V1 Monitor Messages Get"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -3848,25 +4098,38 @@
},
"delete": {
"tags": [
- "mcp_projects"
+ "Monitor"
],
- "summary": "Handle Project Streamable Http",
- "description": "Handle Streamable HTTP connections for a specific project.",
- "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable__post",
- "parameters": [
+ "summary": "Delete Messages",
+ "operationId": "delete_messages_api_v1_monitor_messages_delete",
+ "security": [
{
- "name": "project_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
- }
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "title": "Message Ids"
+ }
+ }
+ }
+ },
"responses": {
- "200": {
+ "204": {
"description": "Successful Response"
},
"422": {
@@ -3882,17 +4145,16 @@
}
}
},
- "/api/v1/mcp/project/{project_id}/install": {
- "post": {
+ "/api/v1/monitor/messages/{message_id}": {
+ "put": {
"tags": [
- "mcp_projects"
+ "Monitor"
],
- "summary": "Install Mcp Config",
- "description": "Install MCP server configuration for Cursor, Windsurf, or Claude.",
- "operationId": "install_mcp_config_api_v1_mcp_project__project_id__install_post",
+ "summary": "Update Message",
+ "operationId": "update_message_api_v1_monitor_messages__message_id__put",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -3903,13 +4165,13 @@
],
"parameters": [
{
- "name": "project_id",
+ "name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
+ "title": "Message Id"
}
}
],
@@ -3918,7 +4180,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MCPInstallRequest"
+ "$ref": "#/components/schemas/MessageUpdate"
}
}
}
@@ -3928,7 +4190,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/MessageRead"
+ }
}
}
},
@@ -3945,17 +4209,16 @@
}
}
},
- "/api/v1/mcp/project/{project_id}/composer-url": {
- "get": {
+ "/api/v1/monitor/messages/session/{old_session_id}": {
+ "patch": {
"tags": [
- "mcp_projects"
+ "Monitor"
],
- "summary": "Get Project Composer Url",
- "description": "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.",
- "operationId": "get_project_composer_url_api_v1_mcp_project__project_id__composer_url_get",
+ "summary": "Update Session Id",
+ "operationId": "update_session_id_api_v1_monitor_messages_session__old_session_id__patch",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -3966,14 +4229,24 @@
],
"parameters": [
{
- "name": "project_id",
+ "name": "old_session_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "title": "Old Session Id"
}
+ },
+ {
+ "name": "new_session_id",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "The new session ID to update to",
+ "title": "New Session Id"
+ },
+ "description": "The new session ID to update to"
}
],
"responses": {
@@ -3982,7 +4255,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ComposerUrlResponse"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MessageResponse"
+ },
+ "title": "Response Update Session Id Api V1 Monitor Messages Session Old Session Id Patch"
}
}
}
@@ -4000,17 +4277,16 @@
}
}
},
- "/api/v1/mcp/project/{project_id}/installed": {
- "get": {
+ "/api/v1/monitor/messages/session/{session_id}": {
+ "delete": {
"tags": [
- "mcp_projects"
+ "Monitor"
],
- "summary": "Check Installed Mcp Servers",
- "description": "Check if MCP server configuration is installed for this project in Cursor, Windsurf, or Claude.",
- "operationId": "check_installed_mcp_servers_api_v1_mcp_project__project_id__installed_get",
+ "summary": "Delete Messages Session",
+ "operationId": "delete_messages_session_api_v1_monitor_messages_session__session_id__delete",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -4021,24 +4297,18 @@
],
"parameters": [
{
- "name": "project_id",
+ "name": "session_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "title": "Session Id"
}
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -4053,65 +4323,16 @@
}
}
},
- "/api/v1/responses": {
- "post": {
+ "/api/v1/monitor/transactions": {
+ "get": {
"tags": [
- "OpenAI Responses API"
+ "Monitor"
],
- "summary": "Create Response",
- "description": "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",
- "operationId": "create_response_api_v1_responses_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/OpenAIResponsesRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- },
- "security": [
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ]
- }
- },
- "/api/v1/agentic/execute/{flow_name}": {
- "post": {
- "tags": [
- "Agentic"
- ],
- "summary": "Execute Named Flow",
- "description": "Execute a named flow from the flows directory.",
- "operationId": "execute_named_flow_api_v1_agentic_execute__flow_name__post",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
+ "summary": "Get Transactions",
+ "operationId": "get_transactions_api_v1_monitor_transactions_get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -4122,34 +4343,50 @@
],
"parameters": [
{
- "name": "flow_name",
- "in": "path",
+ "name": "flow_id",
+ "in": "query",
"required": true,
"schema": {
"type": "string",
- "title": "Flow Name"
+ "format": "uuid",
+ "title": "Flow Id"
}
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "Page number",
+ "default": 1,
+ "title": "Page"
+ },
+ "description": "Page number"
+ },
+ {
+ "name": "size",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 100,
+ "minimum": 1,
+ "description": "Page size",
+ "default": 50,
+ "title": "Size"
+ },
+ "description": "Page size"
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AssistantRequest"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "object",
- "additionalProperties": true,
- "title": "Response Execute Named Flow Api V1 Agentic Execute Flow Name Post"
+ "$ref": "#/components/schemas/Page_TransactionTable_"
}
}
}
@@ -4167,68 +4404,149 @@
}
}
},
- "/api/v1/agentic/check-config": {
+ "/api/v1/folders/": {
"get": {
"tags": [
- "Agentic"
+ "Folders"
],
- "summary": "Check Assistant Config",
- "description": "Check if the Langflow Assistant is properly configured.
Returns available providers with their configured status and available models.",
- "operationId": "check_assistant_config_api_v1_agentic_check_config_get",
+ "summary": "Read Folders Redirect",
+ "description": "Redirect to the projects endpoint.",
+ "operationId": "read_folders_redirect_api_v1_folders__get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "additionalProperties": true,
- "type": "object",
- "title": "Response Check Assistant Config Api V1 Agentic Check Config Get"
+ "items": {
+ "$ref": "#/components/schemas/FolderRead"
+ },
+ "type": "array",
+ "title": "Response Read Folders Redirect Api V1 Folders Get"
}
}
}
}
- },
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
+ }
+ },
+ "post": {
+ "tags": [
+ "Folders"
+ ],
+ "summary": "Create Folder Redirect",
+ "description": "Redirect to the projects endpoint.",
+ "operationId": "create_folder_redirect_api_v1_folders__post",
+ "responses": {
+ "201": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FolderRead"
+ }
+ }
+ }
}
- ]
+ }
}
},
- "/api/v1/agentic/assist": {
- "post": {
+ "/api/v1/folders/{folder_id}": {
+ "get": {
"tags": [
- "Agentic"
+ "Folders"
],
- "summary": "Assist",
- "description": "Chat with the Langflow Assistant.",
- "operationId": "assist_api_v1_agentic_assist_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AssistantRequest"
- }
+ "summary": "Read Folder Redirect",
+ "description": "Redirect to the projects endpoint.",
+ "operationId": "read_folder_redirect_api_v1_folders__folder_id__get",
+ "parameters": [
+ {
+ "name": "folder_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Folder Id"
}
},
- "required": true
- },
+ {
+ "name": "is_component",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Is Component"
+ }
+ },
+ {
+ "name": "is_flow",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Is Flow"
+ }
+ },
+ {
+ "name": "search",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "",
+ "title": "Search"
+ }
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Page"
+ }
+ },
+ {
+ "name": "size",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Size"
+ }
+ }
+ ],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "additionalProperties": true,
- "type": "object",
- "title": "Response Assist Api V1 Agentic Assist Post"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/FolderWithPaginatedFlows"
+ },
+ {
+ "$ref": "#/components/schemas/FolderReadWithFlows"
+ }
+ ],
+ "title": "Response Read Folder Redirect Api V1 Folders Folder Id Get"
}
}
}
@@ -4243,44 +4561,35 @@
}
}
}
- },
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ]
- }
- },
- "/api/v1/agentic/assist/stream": {
- "post": {
+ }
+ },
+ "patch": {
"tags": [
- "Agentic"
+ "Folders"
],
- "summary": "Assist Stream",
- "description": "Chat with the Langflow Assistant with streaming progress updates.",
- "operationId": "assist_stream_api_v1_agentic_assist_stream_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AssistantRequest"
- }
+ "summary": "Update Folder Redirect",
+ "description": "Redirect to the projects endpoint.",
+ "operationId": "update_folder_redirect_api_v1_folders__folder_id__patch",
+ "parameters": [
+ {
+ "name": "folder_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Folder Id"
}
- },
- "required": true
- },
+ }
+ ],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/FolderRead"
+ }
}
}
},
@@ -4294,71 +4603,30 @@
}
}
}
- },
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
+ }
+ },
+ "delete": {
+ "tags": [
+ "Folders"
+ ],
+ "summary": "Delete Folder Redirect",
+ "description": "Redirect to the projects endpoint.",
+ "operationId": "delete_folder_redirect_api_v1_folders__folder_id__delete",
+ "parameters": [
{
- "API key query": []
- },
- {
- "API key header": []
- }
- ]
- }
- },
- "/api/v2/files/": {
- "post": {
- "tags": [
- "Files"
- ],
- "summary": "Upload User File",
- "description": "Upload a file for the current user and track it in the database.",
- "operationId": "upload_user_file_api_v2_files__post",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ],
- "parameters": [
- {
- "name": "append",
- "in": "query",
- "required": false,
+ "name": "folder_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "boolean",
- "default": false,
- "title": "Append"
+ "type": "string",
+ "format": "uuid",
+ "title": "Folder Id"
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "multipart/form-data": {
- "schema": {
- "$ref": "#/components/schemas/Body_upload_user_file_api_v2_files__post"
- }
- }
- }
- },
"responses": {
- "201": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UploadFileResponse"
- }
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -4371,23 +4639,26 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/folders/download/{folder_id}": {
"get": {
"tags": [
- "Files"
+ "Folders"
],
- "summary": "List Files",
- "description": "List the files available to the current user.",
- "operationId": "list_files_api_v2_files__get",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
+ "summary": "Download File Redirect",
+ "description": "Redirect to the projects endpoint.",
+ "operationId": "download_file_redirect_api_v1_folders_download__folder_id__get",
+ "parameters": [
{
- "API key header": []
+ "name": "folder_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Folder Id"
+ }
}
],
"responses": {
@@ -4395,157 +4666,75 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/File"
- },
- "title": "Response List Files Api V2 Files Get"
- }
+ "schema": {}
}
}
- }
- }
- },
- "delete": {
- "tags": [
- "Files"
- ],
- "summary": "Delete All Files",
- "description": "Delete all files for the current user.",
- "operationId": "delete_all_files_api_v2_files__delete",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
},
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
+ "422": {
+ "description": "Validation Error",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
}
}
}
}
}
},
- "/api/v2/files": {
+ "/api/v1/folders/upload/": {
"post": {
"tags": [
- "Files"
- ],
- "summary": "Upload User File",
- "description": "Upload a file for the current user and track it in the database.",
- "operationId": "upload_user_file_api_v2_files_post",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ],
- "parameters": [
- {
- "name": "append",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false,
- "title": "Append"
- }
- }
+ "Folders"
],
- "requestBody": {
- "required": true,
- "content": {
- "multipart/form-data": {
- "schema": {
- "$ref": "#/components/schemas/Body_upload_user_file_api_v2_files_post"
- }
- }
- }
- },
+ "summary": "Upload File Redirect",
+ "description": "Redirect to the projects endpoint.",
+ "operationId": "upload_file_redirect_api_v1_folders_upload__post",
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UploadFileResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "items": {
+ "$ref": "#/components/schemas/FlowRead"
+ },
+ "type": "array",
+ "title": "Response Upload File Redirect Api V1 Folders Upload Post"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/projects/": {
"get": {
"tags": [
- "Files"
- ],
- "summary": "List Files",
- "description": "List the files available to the current user.",
- "operationId": "list_files_api_v2_files_get",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
+ "Projects"
],
+ "summary": "Read Projects",
+ "operationId": "read_projects_api_v1_projects__get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
"items": {
- "$ref": "#/components/schemas/File"
+ "$ref": "#/components/schemas/FolderRead"
},
- "title": "Response List Files Api V2 Files Get"
+ "type": "array",
+ "title": "Response Read Projects Api V1 Projects Get"
}
}
}
}
- }
- },
- "delete": {
- "tags": [
- "Files"
- ],
- "summary": "Delete All Files",
- "description": "Delete all files for the current user.",
- "operationId": "delete_all_files_api_v2_files_delete",
+ },
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -4553,48 +4742,32 @@
{
"API key header": []
}
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/api/v2/files/batch/": {
+ ]
+ },
"post": {
"tags": [
- "Files"
+ "Projects"
],
- "summary": "Download Files Batch",
- "description": "Download multiple files as a zip file by their IDs.",
- "operationId": "download_files_batch_api_v2_files_batch__post",
+ "summary": "Create Project",
+ "operationId": "create_project_api_v1_projects__post",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "type": "array",
- "title": "File Ids"
+ "$ref": "#/components/schemas/FolderCreate"
}
}
},
"required": true
},
"responses": {
- "200": {
+ "201": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/FolderRead"
+ }
}
}
},
@@ -4611,7 +4784,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -4620,73 +4793,18 @@
"API key header": []
}
]
- },
- "delete": {
+ }
+ },
+ "/api/v1/projects/{project_id}": {
+ "get": {
"tags": [
- "Files"
+ "Projects"
],
- "summary": "Delete Files Batch",
- "description": "Delete multiple files by their IDs.",
- "operationId": "delete_files_batch_api_v2_files_batch__delete",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "type": "array",
- "title": "File Ids"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- },
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ]
- }
- },
- "/api/v2/files/{file_id}": {
- "get": {
- "tags": [
- "Files"
- ],
- "summary": "Download File",
- "description": "Download a file by its ID or return its content as a string/bytes.
Args:
file_id: UUID of the file.
current_user: Authenticated user.
session: Database session.
storage_service: File storage service.
return_content: If True, return raw content (str) instead of StreamingResponse.
Returns:
StreamingResponse for client downloads or str for internal use.",
- "operationId": "download_file_api_v2_files__file_id__get",
+ "summary": "Read Project",
+ "operationId": "read_project_api_v1_projects__project_id__get",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -4697,83 +4815,75 @@
],
"parameters": [
{
- "name": "file_id",
+ "name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "File Id"
+ "title": "Project Id"
}
},
{
- "name": "return_content",
+ "name": "page",
"in": "query",
"required": false,
"schema": {
- "type": "boolean",
- "default": false,
- "title": "Return Content"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Page"
}
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ {
+ "name": "size",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
}
- }
+ ],
+ "title": "Size"
}
- }
- }
- },
- "put": {
- "tags": [
- "Files"
- ],
- "summary": "Edit File Name",
- "description": "Edit the name of a file by its ID.",
- "operationId": "edit_file_name_api_v2_files__file_id__put",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
},
{
- "API key query": []
+ "name": "is_component",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Is Component"
+ }
},
{
- "API key header": []
- }
- ],
- "parameters": [
- {
- "name": "file_id",
- "in": "path",
- "required": true,
+ "name": "is_flow",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "File Id"
+ "type": "boolean",
+ "default": false,
+ "title": "Is Flow"
}
},
{
- "name": "name",
+ "name": "search",
"in": "query",
- "required": true,
+ "required": false,
"schema": {
"type": "string",
- "title": "Name"
+ "default": "",
+ "title": "Search"
}
}
],
@@ -4783,7 +4893,15 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UploadFileResponse"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/FolderWithPaginatedFlows"
+ },
+ {
+ "$ref": "#/components/schemas/FolderReadWithFlows"
+ }
+ ],
+ "title": "Response Read Project Api V1 Projects Project Id Get"
}
}
}
@@ -4800,16 +4918,15 @@
}
}
},
- "delete": {
+ "patch": {
"tags": [
- "Files"
+ "Projects"
],
- "summary": "Delete File",
- "description": "Delete a file by its ID.",
- "operationId": "delete_file_api_v2_files__file_id__delete",
+ "summary": "Update Project",
+ "operationId": "update_project_api_v1_projects__project_id__patch",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -4820,22 +4937,34 @@
],
"parameters": [
{
- "name": "file_id",
+ "name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "File Id"
+ "title": "Project Id"
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FolderUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/FolderRead"
+ }
}
}
},
@@ -4850,19 +4979,16 @@
}
}
}
- }
- },
- "/api/v2/mcp/servers": {
- "get": {
+ },
+ "delete": {
"tags": [
- "MCP"
+ "Projects"
],
- "summary": "Get Servers",
- "description": "Get the list of available servers.",
- "operationId": "get_servers_api_v2_mcp_servers_get",
+ "summary": "Delete Project",
+ "operationId": "delete_project_api_v1_projects__project_id__delete",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -4873,30 +4999,19 @@
],
"parameters": [
{
- "name": "action_count",
- "in": "query",
- "required": false,
+ "name": "project_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Action Count"
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
}
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -4911,17 +5026,17 @@
}
}
},
- "/api/v2/mcp/servers/{server_name}": {
+ "/api/v1/projects/download/{project_id}": {
"get": {
"tags": [
- "MCP"
+ "Projects"
],
- "summary": "Get Server Endpoint",
- "description": "Get a specific server.",
- "operationId": "get_server_endpoint_api_v2_mcp_servers__server_name__get",
+ "summary": "Download File",
+ "description": "Download all flows from project as a zip file.",
+ "operationId": "download_file_api_v1_projects_download__project_id__get",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -4932,12 +5047,13 @@
],
"parameters": [
{
- "name": "server_name",
+ "name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Server Name"
+ "format": "uuid",
+ "title": "Project Id"
}
}
],
@@ -4961,53 +5077,38 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/projects/upload/": {
"post": {
"tags": [
- "MCP"
- ],
- "summary": "Add Server",
- "operationId": "add_server_api_v2_mcp_servers__server_name__post",
- "security": [
- {
- "OAuth2PasswordBearerCookie": []
- },
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ],
- "parameters": [
- {
- "name": "server_name",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Server Name"
- }
- }
+ "Projects"
],
+ "summary": "Upload File",
+ "description": "Upload flows from a file.",
+ "operationId": "upload_file_api_v1_projects_upload__post",
"requestBody": {
- "required": true,
"content": {
- "application/json": {
+ "multipart/form-data": {
"schema": {
- "type": "object",
- "additionalProperties": true,
- "title": "Server Config"
+ "$ref": "#/components/schemas/Body_upload_file_api_v1_projects_upload__post"
}
}
- }
+ },
+ "required": true
},
"responses": {
- "200": {
+ "201": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/FlowRead"
+ },
+ "type": "array",
+ "title": "Response Upload File Api V1 Projects Upload Post"
+ }
}
}
},
@@ -5021,17 +5122,47 @@
}
}
}
- }
- },
- "patch": {
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ }
+ },
+ "/api/v1/starter-projects/": {
+ "get": {
"tags": [
- "MCP"
+ "Flows"
],
- "summary": "Update Server Endpoint",
- "operationId": "update_server_endpoint_api_v2_mcp_servers__server_name__patch",
+ "summary": "Get Starter Projects",
+ "description": "Get a list of starter projects.",
+ "operationId": "get_starter_projects_api_v1_starter_projects__get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GraphDumpResponse"
+ },
+ "type": "array",
+ "title": "Response Get Starter Projects Api V1 Starter Projects Get"
+ }
+ }
+ }
+ }
+ },
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5039,36 +5170,72 @@
{
"API key header": []
}
+ ]
+ }
+ },
+ "/api/v1/knowledge_bases/": {
+ "get": {
+ "tags": [
+ "Knowledge Bases"
],
- "parameters": [
- {
- "name": "server_name",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Server Name"
+ "summary": "List Knowledge Bases",
+ "description": "List all available knowledge bases.",
+ "operationId": "list_knowledge_bases_api_v1_knowledge_bases__get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/KnowledgeBaseInfo"
+ },
+ "type": "array",
+ "title": "Response List Knowledge Bases Api V1 Knowledge Bases Get"
+ }
+ }
}
}
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Knowledge Bases"
],
+ "summary": "Delete Knowledge Bases Bulk",
+ "description": "Delete multiple knowledge bases.",
+ "operationId": "delete_knowledge_bases_bulk_api_v1_knowledge_bases__delete",
"requestBody": {
- "required": true,
"content": {
"application/json": {
"schema": {
- "type": "object",
- "additionalProperties": true,
- "title": "Server Config"
+ "$ref": "#/components/schemas/BulkDeleteRequest"
}
}
- }
+ },
+ "required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Response Delete Knowledge Bases Bulk Api V1 Knowledge Bases Delete"
+ }
}
}
},
@@ -5082,17 +5249,10 @@
}
}
}
- }
- },
- "delete": {
- "tags": [
- "MCP"
- ],
- "summary": "Delete Server",
- "operationId": "delete_server_api_v2_mcp_servers__server_name__delete",
+ },
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5100,24 +5260,72 @@
{
"API key header": []
}
+ ]
+ }
+ },
+ "/api/v1/knowledge_bases": {
+ "get": {
+ "tags": [
+ "Knowledge Bases"
],
- "parameters": [
- {
- "name": "server_name",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Server Name"
+ "summary": "List Knowledge Bases",
+ "description": "List all available knowledge bases.",
+ "operationId": "list_knowledge_bases_api_v1_knowledge_bases_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/KnowledgeBaseInfo"
+ },
+ "type": "array",
+ "title": "Response List Knowledge Bases Api V1 Knowledge Bases Get"
+ }
+ }
}
}
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Knowledge Bases"
],
+ "summary": "Delete Knowledge Bases Bulk",
+ "description": "Delete multiple knowledge bases.",
+ "operationId": "delete_knowledge_bases_bulk_api_v1_knowledge_bases_delete",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BulkDeleteRequest"
+ }
+ }
+ },
+ "required": true
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Response Delete Knowledge Bases Bulk Api V1 Knowledge Bases Delete"
+ }
}
}
},
@@ -5131,18 +5339,32 @@
}
}
}
- }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
}
},
- "/api/v2/workflows": {
- "post": {
+ "/api/v1/knowledge_bases/{kb_name}": {
+ "get": {
"tags": [
- "Workflow"
+ "Knowledge Bases"
],
- "summary": "Execute Workflow",
- "description": "Execute a workflow with support for sync, stream, and background modes",
- "operationId": "execute_workflow_api_v2_workflows_post",
+ "summary": "Get Knowledge Base",
+ "description": "Get detailed information about a specific knowledge base.",
+ "operationId": "get_knowledge_base_api_v1_knowledge_bases__kb_name__get",
"security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
{
"API key query": []
},
@@ -5150,71 +5372,25 @@
"API key header": []
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/WorkflowExecutionRequest"
- }
+ "parameters": [
+ {
+ "name": "kb_name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Kb Name"
}
}
- },
+ ],
"responses": {
"200": {
- "description": "Workflow execution response",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/WorkflowExecutionResponse"
- },
- {
- "$ref": "#/components/schemas/WorkflowJobResponse"
- }
- ],
- "discriminator": {
- "propertyName": "object",
- "mapping": {
- "response": "#/components/schemas/WorkflowExecutionResponse",
- "job": "#/components/schemas/WorkflowJobResponse"
- }
- }
+ "$ref": "#/components/schemas/KnowledgeBaseInfo"
}
- },
- "text/event-stream": {
- "schema": {
- "description": "Streaming event response.",
- "properties": {
- "type": {
- "title": "Type",
- "type": "string"
- },
- "run_id": {
- "title": "Run Id",
- "type": "string"
- },
- "timestamp": {
- "title": "Timestamp",
- "type": "integer"
- },
- "raw_event": {
- "additionalProperties": true,
- "title": "Raw Event",
- "type": "object"
- }
- },
- "required": [
- "type",
- "run_id",
- "timestamp",
- "raw_event"
- ],
- "title": "WorkflowStreamEvent",
- "type": "object"
- },
- "description": "Server-sent events for streaming execution"
}
}
},
@@ -5230,14 +5406,17 @@
}
}
},
- "get": {
+ "delete": {
"tags": [
- "Workflow"
+ "Knowledge Bases"
],
- "summary": "Get Workflow Status",
- "description": "Get status of workflow job by job ID",
- "operationId": "get_workflow_status_api_v2_workflows_get",
+ "summary": "Delete Knowledge Base",
+ "description": "Delete a specific knowledge base.",
+ "operationId": "delete_knowledge_base_api_v1_knowledge_bases__kb_name__delete",
"security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
{
"API key query": []
},
@@ -5247,172 +5426,26 @@
],
"parameters": [
{
- "name": "job_id",
- "in": "query",
- "required": false,
+ "name": "kb_name",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "description": "Job ID to query",
- "title": "Job Id"
- },
- "description": "Job ID to query"
- }
- ],
- "responses": {
- "200": {
- "description": "Workflow status response",
- "content": {
- "application/json": {
- "schema": {
- "description": "Synchronous workflow execution response.",
- "properties": {
- "flow_id": {
- "title": "Flow Id",
- "type": "string"
- },
- "job_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "format": "uuid",
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Job Id"
- },
- "object": {
- "const": "response",
- "default": "response",
- "title": "Object",
- "type": "string"
- },
- "created_timestamp": {
- "title": "Created Timestamp",
- "type": "string"
- },
- "status": {
- "$ref": "#/components/schemas/JobStatus_2"
- },
- "errors": {
- "default": [],
- "items": {
- "$ref": "#/components/schemas/ErrorDetail_2"
- },
- "title": "Errors",
- "type": "array"
- },
- "inputs": {
- "additionalProperties": true,
- "default": {},
- "title": "Inputs",
- "type": "object"
- },
- "outputs": {
- "additionalProperties": {
- "$ref": "#/components/schemas/ComponentOutput_1"
- },
- "default": {},
- "title": "Outputs",
- "type": "object"
- }
- },
- "required": [
- "flow_id",
- "status"
- ],
- "title": "WorkflowExecutionResponse",
- "type": "object"
- }
- },
- "text/event-stream": {
- "schema": {
- "description": "Streaming event response.",
- "properties": {
- "type": {
- "title": "Type",
- "type": "string"
- },
- "run_id": {
- "title": "Run Id",
- "type": "string"
- },
- "timestamp": {
- "title": "Timestamp",
- "type": "integer"
- },
- "raw_event": {
- "additionalProperties": true,
- "title": "Raw Event",
- "type": "object"
- }
- },
- "required": [
- "type",
- "run_id",
- "timestamp",
- "raw_event"
- ],
- "title": "WorkflowStreamEvent",
- "type": "object"
- },
- "description": "Server-sent events for streaming status"
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
+ "type": "string",
+ "title": "Kb Name"
}
}
- }
- }
- },
- "/api/v2/workflows/stop": {
- "post": {
- "tags": [
- "Workflow"
],
- "summary": "Stop Workflow",
- "description": "Stop a running workflow execution",
- "operationId": "stop_workflow_api_v2_workflows_stop_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/WorkflowStopRequest"
- }
- }
- },
- "required": true
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/WorkflowStopResponse"
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "title": "Response Delete Knowledge Base Api V1 Knowledge Bases Kb Name Delete"
}
}
}
@@ -5427,24 +5460,16 @@
}
}
}
- },
- "security": [
- {
- "API key query": []
- },
- {
- "API key header": []
- }
- ]
+ }
}
},
- "/api/mcp/sse": {
+ "/api/v1/mcp/sse": {
"get": {
"tags": [
"mcp"
],
"summary": "Handle Sse",
- "operationId": "handle_sse_api_mcp_sse_get",
+ "operationId": "handle_sse_api_v1_mcp_sse_get",
"responses": {
"200": {
"description": "Successful Response"
@@ -5452,7 +5477,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5461,34 +5486,15 @@
"API key header": []
}
]
- },
- "head": {
- "tags": [
- "mcp"
- ],
- "summary": "Im Alive",
- "operationId": "im_alive_api_mcp_sse_head",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "text/html": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
}
},
- "/api/mcp/": {
+ "/api/v1/mcp/": {
"post": {
"tags": [
"mcp"
],
"summary": "Handle Messages",
- "operationId": "handle_messages_api_mcp__post",
+ "operationId": "handle_messages_api_v1_mcp__post",
"responses": {
"200": {
"description": "Successful Response",
@@ -5501,14 +5507,14 @@
}
}
},
- "/api/mcp/streamable": {
+ "/api/v1/mcp/streamable/": {
"get": {
"tags": [
"mcp"
],
"summary": "Handle Streamable Http",
"description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_mcp_streamable_post",
+ "operationId": "handle_streamable_http_api_v1_mcp_streamable__post",
"responses": {
"200": {
"description": "Successful Response"
@@ -5516,7 +5522,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5532,7 +5538,7 @@
],
"summary": "Handle Streamable Http",
"description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_mcp_streamable_post",
+ "operationId": "handle_streamable_http_api_v1_mcp_streamable__post",
"responses": {
"200": {
"description": "Successful Response"
@@ -5540,7 +5546,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5556,7 +5562,7 @@
],
"summary": "Handle Streamable Http",
"description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_mcp_streamable_post",
+ "operationId": "handle_streamable_http_api_v1_mcp_streamable__post",
"responses": {
"200": {
"description": "Successful Response"
@@ -5564,7 +5570,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5573,33 +5579,16 @@
"API key header": []
}
]
- },
- "head": {
- "tags": [
- "mcp"
- ],
- "summary": "Streamable Health",
- "operationId": "streamable_health_api_mcp_streamable_head",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
}
},
- "/api/mcp/streamable/": {
+ "/api/v1/mcp/streamable": {
"get": {
"tags": [
"mcp"
],
"summary": "Handle Streamable Http",
"description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_mcp_streamable__post",
+ "operationId": "handle_streamable_http_api_v1_mcp_streamable_post",
"responses": {
"200": {
"description": "Successful Response"
@@ -5607,7 +5596,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5623,7 +5612,7 @@
],
"summary": "Handle Streamable Http",
"description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_mcp_streamable__post",
+ "operationId": "handle_streamable_http_api_v1_mcp_streamable_post",
"responses": {
"200": {
"description": "Successful Response"
@@ -5631,7 +5620,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5647,7 +5636,7 @@
],
"summary": "Handle Streamable Http",
"description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
- "operationId": "handle_streamable_http_api_mcp_streamable__post",
+ "operationId": "handle_streamable_http_api_v1_mcp_streamable_post",
"responses": {
"200": {
"description": "Successful Response"
@@ -5655,7 +5644,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5666,35 +5655,14 @@
]
}
},
- "/health_check": {
- "get": {
- "tags": [
- "Health Check"
- ],
- "summary": "Health Check",
- "operationId": "health_check_health_check_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HealthResponse"
- }
- }
- }
- }
- }
- }
- },
- "/logs-stream": {
+ "/api/v1/voice/elevenlabs/voice_ids": {
"get": {
"tags": [
- "Log"
+ "Voice"
],
- "summary": "Stream Logs",
- "description": "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\".",
- "operationId": "stream_logs_logs_stream_get",
+ "summary": "Get Elevenlabs Voice Ids",
+ "description": "Get available voice IDs from ElevenLabs API.",
+ "operationId": "get_elevenlabs_voice_ids_api_v1_voice_elevenlabs_voice_ids_get",
"responses": {
"200": {
"description": "Successful Response",
@@ -5707,7 +5675,7 @@
},
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5718,17 +5686,17 @@
]
}
},
- "/logs": {
+ "/api/v1/mcp/project/{project_id}": {
"get": {
"tags": [
- "Log"
+ "mcp_projects"
],
- "summary": "Logs",
- "description": "Retrieve application logs with authentication required.
SECURITY: Logs may contain sensitive information and require authentication.",
- "operationId": "logs_logs_get",
+ "summary": "List Project Tools",
+ "description": "List project MCP tools.",
+ "operationId": "list_project_tools_api_v1_mcp_project__project_id__get",
"security": [
{
- "OAuth2PasswordBearerCookie": []
+ "OAuth2PasswordBearer": []
},
{
"API key query": []
@@ -5739,40 +5707,64 @@
],
"parameters": [
{
- "name": "lines_before",
- "in": "query",
- "required": false,
+ "name": "project_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "description": "The number of logs before the timestamp or the last log",
- "default": 0,
- "title": "Lines Before"
- },
- "description": "The number of logs before the timestamp or the last log"
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
},
{
- "name": "lines_after",
+ "name": "mcp_enabled",
"in": "query",
"required": false,
"schema": {
- "type": "integer",
- "description": "The number of logs after the timestamp",
- "default": 0,
- "title": "Lines After"
- },
- "description": "The number of logs after the timestamp"
+ "type": "boolean",
+ "default": true,
+ "title": "Mcp Enabled"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
},
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Handle Project Messages",
+ "description": "Handle POST messages for a project-specific MCP server.",
+ "operationId": "handle_project_messages_api_v1_mcp_project__project_id__post",
+ "parameters": [
{
- "name": "timestamp",
- "in": "query",
- "required": false,
+ "name": "project_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "description": "The timestamp to start getting logs from",
- "default": 0,
- "title": "Timestamp"
- },
- "description": "The timestamp to start getting logs from"
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
}
],
"responses": {
@@ -5795,26 +5787,2945 @@
}
}
}
- }
- }
- },
- "components": {
- "schemas": {
- "AccessTypeEnum": {
- "type": "string",
+ },
+ "patch": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Update Project Mcp Settings",
+ "description": "Update the MCP settings of all flows in a project and project-level auth settings.
On MCP Composer 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.",
+ "operationId": "update_project_mcp_settings_api_v1_mcp_project__project_id__patch",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MCPProjectUpdateRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/mcp/project/{project_id}/sse": {
+ "get": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Handle Project Sse",
+ "description": "Handle SSE connections for a specific project.",
+ "operationId": "handle_project_sse_api_v1_mcp_project__project_id__sse_get",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "text/html": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/mcp/project/{project_id}/": {
+ "post": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Handle Project Messages",
+ "description": "Handle POST messages for a project-specific MCP server.",
+ "operationId": "handle_project_messages_api_v1_mcp_project__project_id___post",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/mcp/project/{project_id}/streamable/": {
+ "post": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Handle Project Streamable Http",
+ "description": "Handle Streamable HTTP connections for a specific project.",
+ "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable__post",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Handle Project Streamable Http",
+ "description": "Handle Streamable HTTP connections for a specific project.",
+ "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable__post",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Handle Project Streamable Http",
+ "description": "Handle Streamable HTTP connections for a specific project.",
+ "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable__post",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/mcp/project/{project_id}/streamable": {
+ "post": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Handle Project Streamable Http",
+ "description": "Handle Streamable HTTP connections for a specific project.",
+ "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_post",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Handle Project Streamable Http",
+ "description": "Handle Streamable HTTP connections for a specific project.",
+ "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_post",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Handle Project Streamable Http",
+ "description": "Handle Streamable HTTP connections for a specific project.",
+ "operationId": "handle_project_streamable_http_api_v1_mcp_project__project_id__streamable_post",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/mcp/project/{project_id}/install": {
+ "post": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Install Mcp Config",
+ "description": "Install MCP server configuration for Cursor, Windsurf, or Claude.",
+ "operationId": "install_mcp_config_api_v1_mcp_project__project_id__install_post",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MCPInstallRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/mcp/project/{project_id}/composer-url": {
+ "get": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Get Project Composer Url",
+ "description": "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.",
+ "operationId": "get_project_composer_url_api_v1_mcp_project__project_id__composer_url_get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ComposerUrlResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/mcp/project/{project_id}/installed": {
+ "get": {
+ "tags": [
+ "mcp_projects"
+ ],
+ "summary": "Check Installed Mcp Servers",
+ "description": "Check if MCP server configuration is installed for this project in Cursor, Windsurf, or Claude.",
+ "operationId": "check_installed_mcp_servers_api_v1_mcp_project__project_id__installed_get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/responses": {
+ "post": {
+ "tags": [
+ "OpenAI Responses API"
+ ],
+ "summary": "Create Response",
+ "description": "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",
+ "operationId": "create_response_api_v1_responses_post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OpenAIResponsesRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ }
+ },
+ "/api/v2/files/": {
+ "post": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "Upload User File",
+ "description": "Upload a file for the current user and track it in the database.",
+ "operationId": "upload_user_file_api_v2_files__post",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "append",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Append"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_upload_user_file_api_v2_files__post"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/langflow__api__schemas__UploadFileResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "List Files",
+ "description": "List the files available to the current user.",
+ "operationId": "list_files_api_v2_files__get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/File"
+ },
+ "title": "Response List Files Api V2 Files Get"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "Delete All Files",
+ "description": "Delete all files for the current user.",
+ "operationId": "delete_all_files_api_v2_files__delete",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/files": {
+ "post": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "Upload User File",
+ "description": "Upload a file for the current user and track it in the database.",
+ "operationId": "upload_user_file_api_v2_files_post",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "append",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Append"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_upload_user_file_api_v2_files_post"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/langflow__api__schemas__UploadFileResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "List Files",
+ "description": "List the files available to the current user.",
+ "operationId": "list_files_api_v2_files_get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/File"
+ },
+ "title": "Response List Files Api V2 Files Get"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "Delete All Files",
+ "description": "Delete all files for the current user.",
+ "operationId": "delete_all_files_api_v2_files_delete",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/files/batch/": {
+ "post": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "Download Files Batch",
+ "description": "Download multiple files as a zip file by their IDs.",
+ "operationId": "download_files_batch_api_v2_files_batch__post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "type": "array",
+ "title": "File Ids"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "Delete Files Batch",
+ "description": "Delete multiple files by their IDs.",
+ "operationId": "delete_files_batch_api_v2_files_batch__delete",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "type": "array",
+ "title": "File Ids"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ }
+ },
+ "/api/v2/files/{file_id}": {
+ "get": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "Download File",
+ "description": "Download a file by its ID or return its content as a string/bytes.
Args:
file_id: UUID of the file.
current_user: Authenticated user.
session: Database session.
storage_service: File storage service.
return_content: If True, return raw content (str) instead of StreamingResponse.
Returns:
StreamingResponse for client downloads or str for internal use.",
+ "operationId": "download_file_api_v2_files__file_id__get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "file_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "File Id"
+ }
+ },
+ {
+ "name": "return_content",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Return Content"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "Edit File Name",
+ "description": "Edit the name of a file by its ID.",
+ "operationId": "edit_file_name_api_v2_files__file_id__put",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "file_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "File Id"
+ }
+ },
+ {
+ "name": "name",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Name"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/langflow__api__schemas__UploadFileResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Files"
+ ],
+ "summary": "Delete File",
+ "description": "Delete a file by its ID.",
+ "operationId": "delete_file_api_v2_files__file_id__delete",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "file_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "File Id"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/mcp/servers": {
+ "get": {
+ "tags": [
+ "MCP"
+ ],
+ "summary": "Get Servers",
+ "description": "Get the list of available servers.",
+ "operationId": "get_servers_api_v2_mcp_servers_get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "action_count",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Action Count"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/mcp/servers/{server_name}": {
+ "get": {
+ "tags": [
+ "MCP"
+ ],
+ "summary": "Get Server Endpoint",
+ "description": "Get a specific server.",
+ "operationId": "get_server_endpoint_api_v2_mcp_servers__server_name__get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "server_name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Server Name"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "MCP"
+ ],
+ "summary": "Add Server",
+ "operationId": "add_server_api_v2_mcp_servers__server_name__post",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "server_name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Server Name"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true,
+ "title": "Server Config"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "MCP"
+ ],
+ "summary": "Update Server Endpoint",
+ "operationId": "update_server_endpoint_api_v2_mcp_servers__server_name__patch",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "server_name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Server Name"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true,
+ "title": "Server Config"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "MCP"
+ ],
+ "summary": "Delete Server",
+ "operationId": "delete_server_api_v2_mcp_servers__server_name__delete",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "server_name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Server Name"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v2/registration/": {
+ "get": {
+ "tags": [
+ "Registration API"
+ ],
+ "summary": "Get Registration",
+ "description": "Get the registered user (if any).",
+ "operationId": "get_registration_api_v2_registration__get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Registration API"
+ ],
+ "summary": "Register User",
+ "description": "Register the single user with email.
Note: Only one registration is allowed.",
+ "operationId": "register_user_api_v2_registration__post",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RegisterRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RegisterResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/mcp/sse": {
+ "get": {
+ "tags": [
+ "mcp"
+ ],
+ "summary": "Handle Sse",
+ "operationId": "handle_sse_api_mcp_sse_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ }
+ },
+ "/api/mcp/": {
+ "post": {
+ "tags": [
+ "mcp"
+ ],
+ "summary": "Handle Messages",
+ "operationId": "handle_messages_api_mcp__post",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/mcp/streamable/": {
+ "get": {
+ "tags": [
+ "mcp"
+ ],
+ "summary": "Handle Streamable Http",
+ "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
+ "operationId": "handle_streamable_http_api_mcp_streamable__post",
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "mcp"
+ ],
+ "summary": "Handle Streamable Http",
+ "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
+ "operationId": "handle_streamable_http_api_mcp_streamable__post",
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "mcp"
+ ],
+ "summary": "Handle Streamable Http",
+ "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
+ "operationId": "handle_streamable_http_api_mcp_streamable__post",
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ }
+ },
+ "/api/mcp/streamable": {
+ "get": {
+ "tags": [
+ "mcp"
+ ],
+ "summary": "Handle Streamable Http",
+ "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
+ "operationId": "handle_streamable_http_api_mcp_streamable_post",
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "mcp"
+ ],
+ "summary": "Handle Streamable Http",
+ "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
+ "operationId": "handle_streamable_http_api_mcp_streamable_post",
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "mcp"
+ ],
+ "summary": "Handle Streamable Http",
+ "description": "Streamable HTTP endpoint for MCP clients that support the new transport.",
+ "operationId": "handle_streamable_http_api_mcp_streamable_post",
+ "responses": {
+ "200": {
+ "description": "Successful Response"
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ }
+ },
+ "/health": {
+ "get": {
+ "tags": [
+ "Health Check"
+ ],
+ "summary": "Health",
+ "operationId": "health_health_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ }
+ }
+ }
+ },
+ "/health_check": {
+ "get": {
+ "tags": [
+ "Health Check"
+ ],
+ "summary": "Health Check",
+ "operationId": "health_check_health_check_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HealthResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/logs-stream": {
+ "get": {
+ "tags": [
+ "Log"
+ ],
+ "summary": "Stream Logs",
+ "description": "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\".",
+ "operationId": "stream_logs_logs_stream_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ]
+ }
+ },
+ "/logs": {
+ "get": {
+ "tags": [
+ "Log"
+ ],
+ "summary": "Logs",
+ "description": "Retrieve application logs with authentication required.
SECURITY: Logs may contain sensitive information and require authentication.",
+ "operationId": "logs_logs_get",
+ "security": [
+ {
+ "OAuth2PasswordBearer": []
+ },
+ {
+ "API key query": []
+ },
+ {
+ "API key header": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "lines_before",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "description": "The number of logs before the timestamp or the last log",
+ "default": 0,
+ "title": "Lines Before"
+ },
+ "description": "The number of logs before the timestamp or the last log"
+ },
+ {
+ "name": "lines_after",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "description": "The number of logs after the timestamp",
+ "default": 0,
+ "title": "Lines After"
+ },
+ "description": "The number of logs after the timestamp"
+ },
+ {
+ "name": "timestamp",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "description": "The timestamp to start getting logs from",
+ "default": 0,
+ "title": "Timestamp"
+ },
+ "description": "The timestamp to start getting logs from"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "AccessTypeEnum": {
+ "type": "string",
"enum": [
"PRIVATE",
"PUBLIC"
],
- "title": "AccessTypeEnum"
+ "title": "AccessTypeEnum"
+ },
+ "ApiKeyCreate": {
+ "properties": {
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name"
+ },
+ "last_used_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Last Used At"
+ },
+ "total_uses": {
+ "type": "integer",
+ "title": "Total Uses",
+ "default": 0
+ },
+ "is_active": {
+ "type": "boolean",
+ "title": "Is Active",
+ "default": true
+ },
+ "api_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Api Key"
+ },
+ "user_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "User Id"
+ },
+ "created_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Created At"
+ }
+ },
+ "type": "object",
+ "title": "ApiKeyCreate"
+ },
+ "ApiKeyCreateRequest": {
+ "properties": {
+ "api_key": {
+ "type": "string",
+ "title": "Api Key"
+ }
+ },
+ "type": "object",
+ "required": [
+ "api_key"
+ ],
+ "title": "ApiKeyCreateRequest"
+ },
+ "ApiKeyRead": {
+ "properties": {
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name"
+ },
+ "last_used_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Last Used At"
+ },
+ "total_uses": {
+ "type": "integer",
+ "title": "Total Uses",
+ "default": 0
+ },
+ "is_active": {
+ "type": "boolean",
+ "title": "Is Active",
+ "default": true
+ },
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ },
+ "api_key": {
+ "type": "string",
+ "title": "Api Key"
+ },
+ "user_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "User Id"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "api_key",
+ "user_id",
+ "created_at"
+ ],
+ "title": "ApiKeyRead"
+ },
+ "ApiKeysResponse": {
+ "properties": {
+ "total_count": {
+ "type": "integer",
+ "title": "Total Count"
+ },
+ "user_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "User Id"
+ },
+ "api_keys": {
+ "items": {
+ "$ref": "#/components/schemas/ApiKeyRead"
+ },
+ "type": "array",
+ "title": "Api Keys"
+ }
+ },
+ "type": "object",
+ "required": [
+ "total_count",
+ "user_id",
+ "api_keys"
+ ],
+ "title": "ApiKeysResponse"
+ },
+ "AuthSettings": {
+ "properties": {
+ "auth_type": {
+ "type": "string",
+ "enum": [
+ "none",
+ "apikey",
+ "oauth"
+ ],
+ "title": "Auth Type",
+ "default": "none"
+ },
+ "oauth_host": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Oauth Host"
+ },
+ "oauth_port": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Oauth Port"
+ },
+ "oauth_server_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Oauth Server Url"
+ },
+ "oauth_callback_path": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Oauth Callback Path"
+ },
+ "oauth_client_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Oauth Client Id"
+ },
+ "oauth_client_secret": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "password",
+ "writeOnly": true
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Oauth Client Secret"
+ },
+ "oauth_auth_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Oauth Auth Url"
+ },
+ "oauth_token_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Oauth Token Url"
+ },
+ "oauth_mcp_scope": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Oauth Mcp Scope"
+ },
+ "oauth_provider_scope": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Oauth Provider Scope"
+ }
+ },
+ "type": "object",
+ "title": "AuthSettings",
+ "description": "Model representing authentication settings for MCP."
+ },
+ "BaseModel": {
+ "properties": {},
+ "type": "object",
+ "title": "BaseModel"
+ },
+ "Body_build_flow_api_v1_build__flow_id__flow_post": {
+ "properties": {
+ "inputs": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/InputValueRequest"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "data": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/FlowDataRequest"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "files": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Files"
+ }
+ },
+ "type": "object",
+ "title": "Body_build_flow_api_v1_build__flow_id__flow_post"
+ },
+ "Body_build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post": {
+ "properties": {
+ "inputs": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/InputValueRequest"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "data": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/FlowDataRequest"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "files": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Files"
+ }
+ },
+ "type": "object",
+ "title": "Body_build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post"
+ },
+ "Body_build_vertex_api_v1_build__flow_id__vertices__vertex_id__post": {
+ "properties": {
+ "inputs": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/InputValueRequest"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "files": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Files"
+ }
+ },
+ "type": "object",
+ "title": "Body_build_vertex_api_v1_build__flow_id__vertices__vertex_id__post"
+ },
+ "Body_create_upload_file_api_v1_upload__flow_id__post": {
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary",
+ "title": "File"
+ }
+ },
+ "type": "object",
+ "required": [
+ "file"
+ ],
+ "title": "Body_create_upload_file_api_v1_upload__flow_id__post"
+ },
+ "Body_experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post": {
+ "properties": {
+ "inputs": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/InputValueRequest"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Inputs"
+ },
+ "outputs": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Outputs"
+ },
+ "tweaks": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Tweaks"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "stream": {
+ "type": "boolean",
+ "title": "Stream",
+ "default": false
+ },
+ "session_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session Id"
+ }
+ },
+ "type": "object",
+ "title": "Body_experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post"
+ },
+ "Body_login_to_get_access_token_api_v1_login_post": {
+ "properties": {
+ "grant_type": {
+ "anyOf": [
+ {
+ "type": "string",
+ "pattern": "^password$"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Grant Type"
+ },
+ "username": {
+ "type": "string",
+ "title": "Username"
+ },
+ "password": {
+ "type": "string",
+ "format": "password",
+ "title": "Password"
+ },
+ "scope": {
+ "type": "string",
+ "title": "Scope",
+ "default": ""
+ },
+ "client_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Client Id"
+ },
+ "client_secret": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "format": "password",
+ "title": "Client Secret"
+ }
+ },
+ "type": "object",
+ "required": [
+ "username",
+ "password"
+ ],
+ "title": "Body_login_to_get_access_token_api_v1_login_post"
+ },
+ "Body_simplified_run_flow_api_v1_run__flow_id_or_name__post": {
+ "properties": {
+ "input_request": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/SimplifiedAPIRequest"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "context": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Context"
+ }
+ },
+ "type": "object",
+ "title": "Body_simplified_run_flow_api_v1_run__flow_id_or_name__post"
+ },
+ "Body_simplified_run_flow_session_api_v1_run_session__flow_id_or_name__post": {
+ "properties": {
+ "input_request": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/SimplifiedAPIRequest"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "context": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Context"
+ }
+ },
+ "type": "object",
+ "title": "Body_simplified_run_flow_session_api_v1_run_session__flow_id_or_name__post"
+ },
+ "Body_upload_file_api_v1_files_upload__flow_id__post": {
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary",
+ "title": "File"
+ }
+ },
+ "type": "object",
+ "required": [
+ "file"
+ ],
+ "title": "Body_upload_file_api_v1_files_upload__flow_id__post"
+ },
+ "Body_upload_file_api_v1_flows_upload__post": {
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary",
+ "title": "File"
+ }
+ },
+ "type": "object",
+ "required": [
+ "file"
+ ],
+ "title": "Body_upload_file_api_v1_flows_upload__post"
+ },
+ "Body_upload_file_api_v1_projects_upload__post": {
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary",
+ "title": "File"
+ }
+ },
+ "type": "object",
+ "required": [
+ "file"
+ ],
+ "title": "Body_upload_file_api_v1_projects_upload__post"
+ },
+ "Body_upload_user_file_api_v2_files__post": {
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary",
+ "title": "File"
+ }
+ },
+ "type": "object",
+ "required": [
+ "file"
+ ],
+ "title": "Body_upload_user_file_api_v2_files__post"
+ },
+ "Body_upload_user_file_api_v2_files_post": {
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary",
+ "title": "File"
+ }
+ },
+ "type": "object",
+ "required": [
+ "file"
+ ],
+ "title": "Body_upload_user_file_api_v2_files_post"
+ },
+ "BulkDeleteRequest": {
+ "properties": {
+ "kb_names": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Kb Names"
+ }
+ },
+ "type": "object",
+ "required": [
+ "kb_names"
+ ],
+ "title": "BulkDeleteRequest"
+ },
+ "CancelFlowResponse": {
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "Success"
+ },
+ "message": {
+ "type": "string",
+ "title": "Message"
+ }
+ },
+ "type": "object",
+ "required": [
+ "success",
+ "message"
+ ],
+ "title": "CancelFlowResponse",
+ "description": "Response model for flow build cancellation."
+ },
+ "ChatOutputResponse": {
+ "properties": {
+ "message": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
+ }
+ ]
+ },
+ "type": "array"
+ }
+ ],
+ "title": "Message"
+ },
+ "sender": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sender",
+ "default": "Machine"
+ },
+ "sender_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sender Name",
+ "default": "AI"
+ },
+ "session_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session Id"
+ },
+ "stream_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Stream Url"
+ },
+ "component_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Component Id"
+ },
+ "files": {
+ "items": {
+ "$ref": "#/components/schemas/lfx__utils__schemas__File"
+ },
+ "type": "array",
+ "title": "Files",
+ "default": []
+ },
+ "type": {
+ "type": "string",
+ "title": "Type"
+ }
+ },
+ "type": "object",
+ "required": [
+ "message",
+ "type"
+ ],
+ "title": "ChatOutputResponse",
+ "description": "Chat output response schema."
+ },
+ "Code": {
+ "properties": {
+ "code": {
+ "type": "string",
+ "title": "Code"
+ }
+ },
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "title": "Code"
+ },
+ "CodeContent": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "CodeValidationResponse": {
+ "properties": {
+ "imports": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Imports"
+ },
+ "function": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Function"
+ }
+ },
+ "type": "object",
+ "required": [
+ "imports",
+ "function"
+ ],
+ "title": "CodeValidationResponse"
},
- "AssistantRequest": {
+ "ComposerUrlResponse": {
"properties": {
- "flow_id": {
+ "project_id": {
"type": "string",
- "title": "Flow Id"
+ "title": "Project Id"
},
- "component_id": {
+ "uses_composer": {
+ "type": "boolean",
+ "title": "Uses Composer"
+ },
+ "streamable_http_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Streamable Http Url"
+ },
+ "legacy_sse_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Legacy Sse Url"
+ },
+ "error_message": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error Message"
+ }
+ },
+ "type": "object",
+ "required": [
+ "project_id",
+ "uses_composer"
+ ],
+ "title": "ComposerUrlResponse",
+ "description": "Response model for MCP Composer connection details."
+ },
+ "ConfigResponse": {
+ "properties": {
+ "feature_flags": {
+ "$ref": "#/components/schemas/FeatureFlags"
+ },
+ "serialization_max_items_length": {
+ "type": "integer",
+ "title": "Serialization Max Items Length"
+ },
+ "serialization_max_text_length": {
+ "type": "integer",
+ "title": "Serialization Max Text Length"
+ },
+ "frontend_timeout": {
+ "type": "integer",
+ "title": "Frontend Timeout"
+ },
+ "auto_saving": {
+ "type": "boolean",
+ "title": "Auto Saving"
+ },
+ "auto_saving_interval": {
+ "type": "integer",
+ "title": "Auto Saving Interval"
+ },
+ "health_check_max_retries": {
+ "type": "integer",
+ "title": "Health Check Max Retries"
+ },
+ "max_file_size_upload": {
+ "type": "integer",
+ "title": "Max File Size Upload"
+ },
+ "webhook_polling_interval": {
+ "type": "integer",
+ "title": "Webhook Polling Interval"
+ },
+ "public_flow_cleanup_interval": {
+ "type": "integer",
+ "title": "Public Flow Cleanup Interval"
+ },
+ "public_flow_expiration": {
+ "type": "integer",
+ "title": "Public Flow Expiration"
+ },
+ "event_delivery": {
+ "type": "string",
+ "enum": [
+ "polling",
+ "streaming",
+ "direct"
+ ],
+ "title": "Event Delivery"
+ },
+ "webhook_auth_enable": {
+ "type": "boolean",
+ "title": "Webhook Auth Enable"
+ },
+ "voice_mode_available": {
+ "type": "boolean",
+ "title": "Voice Mode Available"
+ },
+ "default_folder_name": {
+ "type": "string",
+ "title": "Default Folder Name"
+ },
+ "hide_getting_started_progress": {
+ "type": "boolean",
+ "title": "Hide Getting Started Progress"
+ }
+ },
+ "type": "object",
+ "required": [
+ "feature_flags",
+ "serialization_max_items_length",
+ "serialization_max_text_length",
+ "frontend_timeout",
+ "auto_saving",
+ "auto_saving_interval",
+ "health_check_max_retries",
+ "max_file_size_upload",
+ "webhook_polling_interval",
+ "public_flow_cleanup_interval",
+ "public_flow_expiration",
+ "event_delivery",
+ "webhook_auth_enable",
+ "voice_mode_available",
+ "default_folder_name",
+ "hide_getting_started_progress"
+ ],
+ "title": "ConfigResponse"
+ },
+ "ContentBlock": {
+ "properties": {
+ "title": {
+ "type": "string",
+ "title": "Title"
+ },
+ "contents": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array",
+ "title": "Contents"
+ },
+ "allow_markdown": {
+ "type": "boolean",
+ "title": "Allow Markdown",
+ "default": true
+ },
+ "media_url": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Media Url"
+ }
+ },
+ "type": "object",
+ "required": [
+ "title",
+ "contents"
+ ],
+ "title": "ContentBlock",
+ "description": "A block of content that can contain different types of content."
+ },
+ "CreateComponentResponse": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id"
+ ],
+ "title": "CreateComponentResponse"
+ },
+ "CustomComponentRequest": {
+ "properties": {
+ "code": {
+ "type": "string",
+ "title": "Code"
+ },
+ "frontend_node": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Frontend Node"
+ }
+ },
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "title": "CustomComponentRequest"
+ },
+ "CustomComponentResponse": {
+ "properties": {
+ "data": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Data"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type"
+ }
+ },
+ "type": "object",
+ "required": [
+ "data",
+ "type"
+ ],
+ "title": "CustomComponentResponse"
+ },
+ "DownloadComponentResponse": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ },
+ "name": {
"anyOf": [
{
"type": "string"
@@ -5823,9 +8734,9 @@
"type": "null"
}
],
- "title": "Component Id"
+ "title": "Name"
},
- "field_name": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -5834,40 +8745,121 @@
"type": "null"
}
],
- "title": "Field Name"
+ "title": "Description"
},
- "input_value": {
+ "data": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Input Value"
+ "title": "Data"
},
- "max_retries": {
+ "is_component": {
"anyOf": [
{
- "type": "integer"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Max Retries"
+ "title": "Is Component"
},
- "model_name": {
+ "metadata": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Model Name"
+ "title": "Metadata",
+ "default": {}
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "name",
+ "description",
+ "data",
+ "is_component"
+ ],
+ "title": "DownloadComponentResponse"
+ },
+ "ErrorContent": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "ErrorLog": {
+ "properties": {
+ "errorMessage": {
+ "type": "string",
+ "title": "Errormessage"
+ },
+ "stackTrace": {
+ "type": "string",
+ "title": "Stacktrace"
+ }
+ },
+ "type": "object",
+ "required": [
+ "errorMessage",
+ "stackTrace"
+ ],
+ "title": "ErrorLog"
+ },
+ "EventDeliveryType": {
+ "type": "string",
+ "enum": [
+ "streaming",
+ "direct",
+ "polling"
+ ],
+ "title": "EventDeliveryType"
+ },
+ "FeatureFlags": {
+ "properties": {
+ "mvp_components": {
+ "type": "boolean",
+ "title": "Mvp Components",
+ "default": false
+ }
+ },
+ "additionalProperties": false,
+ "type": "object",
+ "title": "FeatureFlags"
+ },
+ "File": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ },
+ "user_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "User Id"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "path": {
+ "type": "string",
+ "title": "Path"
+ },
+ "size": {
+ "type": "integer",
+ "title": "Size"
},
"provider": {
"anyOf": [
@@ -5880,38 +8872,33 @@
],
"title": "Provider"
},
- "session_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Session Id"
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Updated At"
}
},
"type": "object",
"required": [
- "flow_id"
+ "user_id",
+ "name",
+ "path",
+ "size"
],
- "title": "AssistantRequest",
- "description": "Request model for assistant interactions."
+ "title": "File"
},
- "AuthSettings": {
+ "Flow": {
"properties": {
- "auth_type": {
+ "name": {
"type": "string",
- "enum": [
- "none",
- "apikey",
- "oauth"
- ],
- "title": "Auth Type",
- "default": "none"
+ "title": "Name"
},
- "oauth_host": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -5920,9 +8907,9 @@
"type": "null"
}
],
- "title": "Oauth Host"
+ "title": "Description"
},
- "oauth_port": {
+ "icon": {
"anyOf": [
{
"type": "string"
@@ -5931,9 +8918,9 @@
"type": "null"
}
],
- "title": "Oauth Port"
+ "title": "Icon"
},
- "oauth_server_url": {
+ "icon_bg_color": {
"anyOf": [
{
"type": "string"
@@ -5942,9 +8929,9 @@
"type": "null"
}
],
- "title": "Oauth Server Url"
+ "title": "Icon Bg Color"
},
- "oauth_callback_path": {
+ "gradient": {
"anyOf": [
{
"type": "string"
@@ -5953,44 +8940,58 @@
"type": "null"
}
],
- "title": "Oauth Callback Path"
+ "title": "Gradient"
},
- "oauth_callback_url": {
+ "data": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Oauth Callback Url"
+ "title": "Data"
},
- "oauth_client_id": {
+ "is_component": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Oauth Client Id"
+ "title": "Is Component",
+ "default": false
},
- "oauth_client_secret": {
+ "updated_at": {
"anyOf": [
{
"type": "string",
- "format": "password",
- "writeOnly": true
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Oauth Client Secret"
+ "title": "Updated At"
},
- "oauth_auth_url": {
+ "webhook": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Webhook",
+ "description": "Can be used on the webhook endpoint",
+ "default": false
+ },
+ "endpoint_name": {
"anyOf": [
{
"type": "string"
@@ -5999,9 +9000,49 @@
"type": "null"
}
],
- "title": "Oauth Auth Url"
+ "title": "Endpoint Name"
},
- "oauth_token_url": {
+ "tags": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Tags",
+ "default": []
+ },
+ "locked": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Locked",
+ "default": false
+ },
+ "mcp_enabled": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Mcp Enabled",
+ "description": "Can be exposed in the MCP server",
+ "default": false
+ },
+ "action_name": {
"anyOf": [
{
"type": "string"
@@ -6010,9 +9051,10 @@
"type": "null"
}
],
- "title": "Oauth Token Url"
+ "title": "Action Name",
+ "description": "The name of the action associated with the flow"
},
- "oauth_mcp_scope": {
+ "action_description": {
"anyOf": [
{
"type": "string"
@@ -6021,9 +9063,43 @@
"type": "null"
}
],
- "title": "Oauth Mcp Scope"
+ "title": "Action Description",
+ "description": "The description of the action associated with the flow"
+ },
+ "access_type": {
+ "$ref": "#/components/schemas/AccessTypeEnum",
+ "default": "PRIVATE"
+ },
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ },
+ "user_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "User Id"
+ },
+ "folder_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Folder Id"
},
- "oauth_provider_scope": {
+ "fs_path": {
"anyOf": [
{
"type": "string"
@@ -6032,139 +9108,116 @@
"type": "null"
}
],
- "title": "Oauth Provider Scope"
+ "title": "Fs Path"
}
},
"type": "object",
- "title": "AuthSettings",
- "description": "Model representing authentication settings for MCP."
+ "required": [
+ "name",
+ "user_id"
+ ],
+ "title": "Flow"
},
- "Body_build_flow_api_v1_build__flow_id__flow_post": {
+ "FlowCreate": {
"properties": {
- "inputs": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/InputValueRequest"
- },
- {
- "type": "null"
- }
- ]
+ "name": {
+ "type": "string",
+ "title": "Name"
},
- "data": {
+ "description": {
"anyOf": [
{
- "$ref": "#/components/schemas/FlowDataRequest"
+ "type": "string"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Description"
},
- "files": {
+ "icon": {
"anyOf": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Files"
- }
- },
- "type": "object",
- "title": "Body_build_flow_api_v1_build__flow_id__flow_post"
- },
- "Body_build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post": {
- "properties": {
- "inputs": {
+ "title": "Icon"
+ },
+ "icon_bg_color": {
"anyOf": [
{
- "$ref": "#/components/schemas/InputValueRequest"
+ "type": "string"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Icon Bg Color"
},
- "data": {
+ "gradient": {
"anyOf": [
{
- "$ref": "#/components/schemas/FlowDataRequest"
+ "type": "string"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Gradient"
},
- "files": {
+ "data": {
"anyOf": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Files"
- }
- },
- "type": "object",
- "title": "Body_build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post"
- },
- "Body_experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post": {
- "properties": {
- "inputs": {
+ "title": "Data"
+ },
+ "is_component": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/InputValueRequest"
- },
- "type": "array"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Inputs"
+ "title": "Is Component",
+ "default": false
},
- "outputs": {
+ "updated_at": {
"anyOf": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Outputs"
+ "title": "Updated At"
},
- "tweaks": {
+ "webhook": {
"anyOf": [
{
- "$ref": "#/components/schemas/Tweaks"
+ "type": "boolean"
},
{
"type": "null"
}
- ]
- },
- "stream": {
- "type": "boolean",
- "title": "Stream",
+ ],
+ "title": "Webhook",
+ "description": "Can be used on the webhook endpoint",
"default": false
},
- "session_id": {
+ "endpoint_name": {
"anyOf": [
{
"type": "string"
@@ -6173,154 +9226,48 @@
"type": "null"
}
],
- "title": "Session Id"
- }
- },
- "type": "object",
- "title": "Body_experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post"
- },
- "Body_simplified_run_flow_api_v1_run__flow_id_or_name__post": {
- "properties": {
- "input_request": {
+ "title": "Endpoint Name"
+ },
+ "tags": {
"anyOf": [
{
- "$ref": "#/components/schemas/SimplifiedAPIRequest"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Tags"
},
- "context": {
+ "locked": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Context"
- }
- },
- "type": "object",
- "title": "Body_simplified_run_flow_api_v1_run__flow_id_or_name__post"
- },
- "Body_upload_file_api_v1_files_upload__flow_id__post": {
- "properties": {
- "file": {
- "type": "string",
- "format": "binary",
- "title": "File"
- }
- },
- "type": "object",
- "required": [
- "file"
- ],
- "title": "Body_upload_file_api_v1_files_upload__flow_id__post"
- },
- "Body_upload_file_api_v1_flows_upload__post": {
- "properties": {
- "file": {
- "type": "string",
- "format": "binary",
- "title": "File"
- }
- },
- "type": "object",
- "required": [
- "file"
- ],
- "title": "Body_upload_file_api_v1_flows_upload__post"
- },
- "Body_upload_file_api_v1_projects_upload__post": {
- "properties": {
- "file": {
- "type": "string",
- "format": "binary",
- "title": "File"
- }
- },
- "type": "object",
- "required": [
- "file"
- ],
- "title": "Body_upload_file_api_v1_projects_upload__post"
- },
- "Body_upload_user_file_api_v2_files__post": {
- "properties": {
- "file": {
- "type": "string",
- "format": "binary",
- "title": "File"
- }
- },
- "type": "object",
- "required": [
- "file"
- ],
- "title": "Body_upload_user_file_api_v2_files__post"
- },
- "Body_upload_user_file_api_v2_files_post": {
- "properties": {
- "file": {
- "type": "string",
- "format": "binary",
- "title": "File"
- }
- },
- "type": "object",
- "required": [
- "file"
- ],
- "title": "Body_upload_user_file_api_v2_files_post"
- },
- "CancelFlowResponse": {
- "properties": {
- "success": {
- "type": "boolean",
- "title": "Success"
+ "title": "Locked",
+ "default": false
},
- "message": {
- "type": "string",
- "title": "Message"
- }
- },
- "type": "object",
- "required": [
- "success",
- "message"
- ],
- "title": "CancelFlowResponse",
- "description": "Response model for flow build cancellation."
- },
- "ChatOutputResponse": {
- "properties": {
- "message": {
+ "mcp_enabled": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "additionalProperties": true,
- "type": "object"
- }
- ]
- },
- "type": "array"
+ "type": "null"
}
],
- "title": "Message"
+ "title": "Mcp Enabled",
+ "description": "Can be exposed in the MCP server",
+ "default": false
},
- "sender": {
+ "action_name": {
"anyOf": [
{
"type": "string"
@@ -6329,10 +9276,10 @@
"type": "null"
}
],
- "title": "Sender",
- "default": "Machine"
+ "title": "Action Name",
+ "description": "The name of the action associated with the flow"
},
- "sender_name": {
+ "action_description": {
"anyOf": [
{
"type": "string"
@@ -6341,32 +9288,38 @@
"type": "null"
}
],
- "title": "Sender Name",
- "default": "AI"
+ "title": "Action Description",
+ "description": "The description of the action associated with the flow"
},
- "session_id": {
+ "access_type": {
+ "$ref": "#/components/schemas/AccessTypeEnum",
+ "default": "PRIVATE"
+ },
+ "user_id": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Session Id"
+ "title": "User Id"
},
- "stream_url": {
+ "folder_id": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Stream Url"
+ "title": "Folder Id"
},
- "component_id": {
+ "fs_path": {
"anyOf": [
{
"type": "string"
@@ -6375,66 +9328,92 @@
"type": "null"
}
],
- "title": "Component Id"
+ "title": "Fs Path"
+ }
+ },
+ "type": "object",
+ "required": [
+ "name"
+ ],
+ "title": "FlowCreate"
+ },
+ "FlowDataRequest": {
+ "properties": {
+ "nodes": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array",
+ "title": "Nodes"
},
- "files": {
+ "edges": {
"items": {
- "$ref": "#/components/schemas/lfx__utils__schemas__File"
+ "additionalProperties": true,
+ "type": "object"
},
"type": "array",
- "title": "Files",
- "default": []
+ "title": "Edges"
},
- "type": {
- "type": "string",
- "title": "Type"
+ "viewport": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Viewport"
}
},
"type": "object",
"required": [
- "message",
- "type"
+ "nodes",
+ "edges"
],
- "title": "ChatOutputResponse",
- "description": "Chat output response schema."
- },
- "CodeContent": {
- "additionalProperties": true,
- "type": "object"
+ "title": "FlowDataRequest"
},
- "ComposerUrlResponse": {
+ "FlowHeader": {
"properties": {
- "project_id": {
+ "id": {
"type": "string",
- "title": "Project Id"
+ "format": "uuid",
+ "title": "Id",
+ "description": "Unique identifier for the flow"
},
- "uses_composer": {
- "type": "boolean",
- "title": "Uses Composer"
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the flow"
},
- "streamable_http_url": {
+ "folder_id": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Streamable Http Url"
+ "title": "Folder Id",
+ "description": "The ID of the folder containing the flow. None if not associated with a folder"
},
- "legacy_sse_url": {
+ "is_component": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Legacy Sse Url"
+ "title": "Is Component",
+ "description": "Flag indicating whether the flow is a component"
},
- "error_message": {
+ "endpoint_name": {
"anyOf": [
{
"type": "string"
@@ -6443,129 +9422,46 @@
"type": "null"
}
],
- "title": "Error Message"
- }
- },
- "type": "object",
- "required": [
- "project_id",
- "uses_composer"
- ],
- "title": "ComposerUrlResponse",
- "description": "Response model for MCP Composer connection details."
- },
- "ConfigResponse": {
- "properties": {
- "feature_flags": {
- "$ref": "#/components/schemas/FeatureFlags"
- },
- "serialization_max_items_length": {
- "type": "integer",
- "title": "Serialization Max Items Length"
- },
- "serialization_max_text_length": {
- "type": "integer",
- "title": "Serialization Max Text Length"
- },
- "frontend_timeout": {
- "type": "integer",
- "title": "Frontend Timeout"
- },
- "auto_saving": {
- "type": "boolean",
- "title": "Auto Saving"
- },
- "auto_saving_interval": {
- "type": "integer",
- "title": "Auto Saving Interval"
- },
- "health_check_max_retries": {
- "type": "integer",
- "title": "Health Check Max Retries"
- },
- "max_file_size_upload": {
- "type": "integer",
- "title": "Max File Size Upload"
- },
- "webhook_polling_interval": {
- "type": "integer",
- "title": "Webhook Polling Interval"
- },
- "public_flow_cleanup_interval": {
- "type": "integer",
- "title": "Public Flow Cleanup Interval"
- },
- "public_flow_expiration": {
- "type": "integer",
- "title": "Public Flow Expiration"
+ "title": "Endpoint Name",
+ "description": "The name of the endpoint associated with this flow"
},
- "event_delivery": {
- "type": "string",
- "enum": [
- "polling",
- "streaming",
- "direct"
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
],
- "title": "Event Delivery"
- },
- "webhook_auth_enable": {
- "type": "boolean",
- "title": "Webhook Auth Enable"
- },
- "voice_mode_available": {
- "type": "boolean",
- "title": "Voice Mode Available"
- },
- "default_folder_name": {
- "type": "string",
- "title": "Default Folder Name"
- },
- "hide_getting_started_progress": {
- "type": "boolean",
- "title": "Hide Getting Started Progress"
- }
- },
- "type": "object",
- "required": [
- "feature_flags",
- "serialization_max_items_length",
- "serialization_max_text_length",
- "frontend_timeout",
- "auto_saving",
- "auto_saving_interval",
- "health_check_max_retries",
- "max_file_size_upload",
- "webhook_polling_interval",
- "public_flow_cleanup_interval",
- "public_flow_expiration",
- "event_delivery",
- "webhook_auth_enable",
- "voice_mode_available",
- "default_folder_name",
- "hide_getting_started_progress"
- ],
- "title": "ConfigResponse"
- },
- "ContentBlock": {
- "properties": {
- "title": {
- "type": "string",
- "title": "Title"
+ "title": "Description",
+ "description": "A description of the flow"
},
- "contents": {
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "type": "array",
- "title": "Contents"
+ "data": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Data",
+ "description": "The data of the component, if is_component is True"
},
- "allow_markdown": {
- "type": "boolean",
- "title": "Allow Markdown",
- "default": true
+ "access_type": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/AccessTypeEnum"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The access type of the flow"
},
- "media_url": {
+ "tags": {
"anyOf": [
{
"items": {
@@ -6577,67 +9473,22 @@
"type": "null"
}
],
- "title": "Media Url"
- }
- },
- "type": "object",
- "required": [
- "title",
- "contents"
- ],
- "title": "ContentBlock",
- "description": "A block of content that can contain different types of content."
- },
- "ErrorContent": {
- "additionalProperties": true,
- "type": "object"
- },
- "EventDeliveryType": {
- "type": "string",
- "enum": [
- "streaming",
- "direct",
- "polling"
- ],
- "title": "EventDeliveryType"
- },
- "FeatureFlags": {
- "properties": {
- "mvp_components": {
- "type": "boolean",
- "title": "Mvp Components",
- "default": false
- }
- },
- "additionalProperties": false,
- "type": "object",
- "title": "FeatureFlags"
- },
- "File": {
- "properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
- },
- "user_id": {
- "type": "string",
- "format": "uuid",
- "title": "User Id"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "path": {
- "type": "string",
- "title": "Path"
+ "title": "Tags",
+ "description": "The tags of the flow"
},
- "size": {
- "type": "integer",
- "title": "Size"
+ "mcp_enabled": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Mcp Enabled",
+ "description": "Flag indicating whether the flow is exposed in the MCP server"
},
- "provider": {
+ "action_name": {
"anyOf": [
{
"type": "string"
@@ -6646,29 +9497,47 @@
"type": "null"
}
],
- "title": "Provider"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At"
+ "title": "Action Name",
+ "description": "The name of the action associated with the flow"
},
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "title": "Updated At"
+ "action_description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Action Description",
+ "description": "The description of the action associated with the flow"
}
},
"type": "object",
"required": [
- "user_id",
- "name",
- "path",
- "size"
+ "id",
+ "name"
],
- "title": "File"
+ "title": "FlowHeader",
+ "description": "Model representing a header for a flow - Without the data."
},
- "Flow": {
+ "FlowListCreate": {
+ "properties": {
+ "flows": {
+ "items": {
+ "$ref": "#/components/schemas/FlowCreate"
+ },
+ "type": "array",
+ "title": "Flows"
+ }
+ },
+ "type": "object",
+ "required": [
+ "flows"
+ ],
+ "title": "FlowListCreate"
+ },
+ "FlowRead": {
"properties": {
"name": {
"type": "string",
@@ -6791,7 +9660,7 @@
}
],
"title": "Tags",
- "default": []
+ "description": "The tags of the flow"
},
"locked": {
"anyOf": [
@@ -6874,44 +9743,20 @@
}
],
"title": "Folder Id"
- },
- "fs_path": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Fs Path"
}
},
"type": "object",
"required": [
"name",
- "user_id"
+ "id",
+ "user_id",
+ "folder_id"
],
- "title": "Flow"
+ "title": "FlowRead"
},
- "FlowCreate": {
+ "FlowUpdate": {
"properties": {
"name": {
- "type": "string",
- "title": "Name"
- },
- "description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Description"
- },
- "icon": {
"anyOf": [
{
"type": "string"
@@ -6920,20 +9765,9 @@
"type": "null"
}
],
- "title": "Icon"
- },
- "icon_bg_color": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Icon Bg Color"
+ "title": "Name"
},
- "gradient": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -6942,7 +9776,7 @@
"type": "null"
}
],
- "title": "Gradient"
+ "title": "Description"
},
"data": {
"anyOf": [
@@ -6956,42 +9790,17 @@
],
"title": "Data"
},
- "is_component": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Is Component",
- "default": false
- },
- "updated_at": {
+ "folder_id": {
"anyOf": [
{
"type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "title": "Updated At"
- },
- "webhook": {
- "anyOf": [
- {
- "type": "boolean"
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Webhook",
- "description": "Can be used on the webhook endpoint",
- "default": false
+ "title": "Folder Id"
},
"endpoint_name": {
"anyOf": [
@@ -7004,32 +9813,6 @@
],
"title": "Endpoint Name"
},
- "tags": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tags"
- },
- "locked": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Locked",
- "default": false
- },
"mcp_enabled": {
"anyOf": [
{
@@ -7039,23 +9822,20 @@
"type": "null"
}
],
- "title": "Mcp Enabled",
- "description": "Can be exposed in the MCP server",
- "default": false
+ "title": "Mcp Enabled"
},
- "action_name": {
+ "locked": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Action Name",
- "description": "The name of the action associated with the flow"
+ "title": "Locked"
},
- "action_description": {
+ "action_name": {
"anyOf": [
{
"type": "string"
@@ -7064,36 +9844,28 @@
"type": "null"
}
],
- "title": "Action Description",
- "description": "The description of the action associated with the flow"
- },
- "access_type": {
- "$ref": "#/components/schemas/AccessTypeEnum",
- "default": "PRIVATE"
+ "title": "Action Name"
},
- "user_id": {
+ "action_description": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "User Id"
+ "title": "Action Description"
},
- "folder_id": {
+ "access_type": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "$ref": "#/components/schemas/AccessTypeEnum"
},
{
"type": "null"
}
- ],
- "title": "Folder Id"
+ ]
},
"fs_path": {
"anyOf": [
@@ -7108,30 +9880,26 @@
}
},
"type": "object",
- "required": [
- "name"
- ],
- "title": "FlowCreate"
+ "title": "FlowUpdate"
},
- "FlowDataRequest": {
+ "FolderCreate": {
"properties": {
- "nodes": {
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "type": "array",
- "title": "Nodes"
+ "name": {
+ "type": "string",
+ "title": "Name"
},
- "edges": {
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "type": "array",
- "title": "Edges"
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Description"
},
- "viewport": {
+ "auth_settings": {
"anyOf": [
{
"additionalProperties": true,
@@ -7141,65 +9909,107 @@
"type": "null"
}
],
- "title": "Viewport"
+ "title": "Auth Settings",
+ "description": "Authentication settings for the folder/project"
+ },
+ "components_list": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Components List"
+ },
+ "flows_list": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Flows List"
}
},
"type": "object",
"required": [
- "nodes",
- "edges"
+ "name"
],
- "title": "FlowDataRequest"
+ "title": "FolderCreate"
},
- "FlowHeader": {
+ "FolderRead": {
"properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id",
- "description": "Unique identifier for the flow"
- },
"name": {
"type": "string",
- "title": "Name",
- "description": "The name of the flow"
+ "title": "Name"
},
- "folder_id": {
+ "description": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Folder Id",
- "description": "The ID of the folder containing the flow. None if not associated with a folder"
+ "title": "Description"
},
- "is_component": {
+ "auth_settings": {
"anyOf": [
{
- "type": "boolean"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Is Component",
- "description": "Flag indicating whether the flow is a component"
+ "title": "Auth Settings",
+ "description": "Authentication settings for the folder/project"
},
- "endpoint_name": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ },
+ "parent_id": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Endpoint Name",
- "description": "The name of the endpoint associated with this flow"
+ "title": "Parent Id"
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "id",
+ "parent_id"
+ ],
+ "title": "FolderRead"
+ },
+ "FolderReadWithFlows": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name"
},
"description": {
"anyOf": [
@@ -7210,10 +10020,9 @@
"type": "null"
}
],
- "title": "Description",
- "description": "A description of the flow"
+ "title": "Description"
},
- "data": {
+ "auth_settings": {
"anyOf": [
{
"additionalProperties": true,
@@ -7223,101 +10032,133 @@
"type": "null"
}
],
- "title": "Data",
- "description": "The data of the component, if is_component is True"
+ "title": "Auth Settings",
+ "description": "Authentication settings for the folder/project"
},
- "access_type": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ },
+ "parent_id": {
"anyOf": [
{
- "$ref": "#/components/schemas/AccessTypeEnum"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "description": "The access type of the flow"
+ "title": "Parent Id"
},
- "tags": {
+ "flows": {
+ "items": {
+ "$ref": "#/components/schemas/FlowRead"
+ },
+ "type": "array",
+ "title": "Flows",
+ "default": []
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "id",
+ "parent_id"
+ ],
+ "title": "FolderReadWithFlows"
+ },
+ "FolderUpdate": {
+ "properties": {
+ "name": {
"anyOf": [
{
- "items": {
- "type": "string"
- },
- "type": "array"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Tags",
- "description": "The tags of the flow"
+ "title": "Name"
},
- "mcp_enabled": {
+ "description": {
"anyOf": [
{
- "type": "boolean"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Mcp Enabled",
- "description": "Flag indicating whether the flow is exposed in the MCP server"
+ "title": "Description"
},
- "action_name": {
+ "parent_id": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Action Name",
- "description": "The name of the action associated with the flow"
+ "title": "Parent Id"
},
- "action_description": {
+ "components": {
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "type": "array",
+ "title": "Components"
+ },
+ "flows": {
+ "items": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "type": "array",
+ "title": "Flows"
+ },
+ "auth_settings": {
"anyOf": [
{
- "type": "string"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Action Description",
- "description": "The description of the action associated with the flow"
- }
- },
- "type": "object",
- "required": [
- "id",
- "name"
- ],
- "title": "FlowHeader",
- "description": "Model representing a header for a flow - Without the data."
+ "title": "Auth Settings"
+ }
+ },
+ "type": "object",
+ "title": "FolderUpdate"
},
- "FlowListCreate": {
+ "FolderWithPaginatedFlows": {
"properties": {
+ "folder": {
+ "$ref": "#/components/schemas/FolderRead"
+ },
"flows": {
- "items": {
- "$ref": "#/components/schemas/FlowCreate"
- },
- "type": "array",
- "title": "Flows"
+ "$ref": "#/components/schemas/Page_Flow_"
}
},
"type": "object",
"required": [
+ "folder",
"flows"
],
- "title": "FlowListCreate"
+ "title": "FolderWithPaginatedFlows"
},
- "FlowRead": {
+ "FrontendNodeRequest-Input": {
"properties": {
- "name": {
- "type": "string",
- "title": "Name"
+ "template": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Template"
},
"description": {
"anyOf": [
@@ -7341,78 +10182,105 @@
],
"title": "Icon"
},
- "icon_bg_color": {
+ "is_input": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Icon Bg Color"
+ "title": "Is Input"
},
- "gradient": {
+ "is_output": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Gradient"
+ "title": "Is Output"
},
- "data": {
+ "is_composition": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Data"
+ "title": "Is Composition"
},
- "is_component": {
+ "base_classes": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Base Classes"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "default": ""
+ },
+ "display_name": {
"anyOf": [
{
- "type": "boolean"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Is Component",
- "default": false
+ "title": "Display Name",
+ "default": ""
},
- "updated_at": {
+ "priority": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Updated At"
+ "title": "Priority"
},
- "webhook": {
+ "documentation": {
+ "type": "string",
+ "title": "Documentation",
+ "default": ""
+ },
+ "minimized": {
+ "type": "boolean",
+ "title": "Minimized",
+ "default": false
+ },
+ "custom_fields": {
"anyOf": [
{
- "type": "boolean"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Webhook",
- "description": "Can be used on the webhook endpoint",
- "default": false
+ "title": "Custom Fields"
},
- "endpoint_name": {
+ "output_types": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Output Types",
+ "default": []
+ },
+ "full_path": {
"anyOf": [
{
"type": "string"
@@ -7421,9 +10289,53 @@
"type": "null"
}
],
- "title": "Endpoint Name"
+ "title": "Full Path"
},
- "tags": {
+ "pinned": {
+ "type": "boolean",
+ "title": "Pinned",
+ "default": false
+ },
+ "conditional_paths": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Conditional Paths",
+ "default": []
+ },
+ "frozen": {
+ "type": "boolean",
+ "title": "Frozen",
+ "default": false
+ },
+ "outputs": {
+ "items": {
+ "$ref": "#/components/schemas/Output"
+ },
+ "type": "array",
+ "title": "Outputs",
+ "default": []
+ },
+ "field_order": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Field Order",
+ "default": []
+ },
+ "beta": {
+ "type": "boolean",
+ "title": "Beta",
+ "default": false
+ },
+ "legacy": {
+ "type": "boolean",
+ "title": "Legacy",
+ "default": false
+ },
+ "replacement": {
"anyOf": [
{
"items": {
@@ -7435,35 +10347,62 @@
"type": "null"
}
],
- "title": "Tags",
- "description": "The tags of the flow"
+ "title": "Replacement"
},
- "locked": {
+ "error": {
"anyOf": [
{
- "type": "boolean"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Locked",
+ "title": "Error"
+ },
+ "edited": {
+ "type": "boolean",
+ "title": "Edited",
"default": false
},
- "mcp_enabled": {
+ "metadata": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Metadata",
+ "default": {}
+ },
+ "tool_mode": {
+ "type": "boolean",
+ "title": "Tool Mode",
+ "default": false
+ }
+ },
+ "type": "object",
+ "required": [
+ "template",
+ "base_classes"
+ ],
+ "title": "FrontendNodeRequest"
+ },
+ "FrontendNodeRequest-Output": {
+ "properties": {
+ "template": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Template"
+ },
+ "description": {
"anyOf": [
{
- "type": "boolean"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Mcp Enabled",
- "description": "Can be exposed in the MCP server",
- "default": false
+ "title": "Description"
},
- "action_name": {
+ "icon": {
"anyOf": [
{
"type": "string"
@@ -7472,78 +10411,99 @@
"type": "null"
}
],
- "title": "Action Name",
- "description": "The name of the action associated with the flow"
+ "title": "Icon"
},
- "action_description": {
+ "is_input": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Action Description",
- "description": "The description of the action associated with the flow"
+ "title": "Is Input"
},
- "access_type": {
- "$ref": "#/components/schemas/AccessTypeEnum",
- "default": "PRIVATE"
- },
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
- },
- "user_id": {
+ "is_output": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "User Id"
+ "title": "Is Output"
},
- "folder_id": {
+ "is_composition": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Folder Id"
- }
- },
- "type": "object",
- "required": [
- "name",
- "id",
- "user_id",
- "folder_id"
- ],
- "title": "FlowRead"
- },
- "FlowUpdate": {
- "properties": {
+ "title": "Is Composition"
+ },
+ "base_classes": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Base Classes"
+ },
"name": {
+ "type": "string",
+ "title": "Name",
+ "default": ""
+ },
+ "display_name": {
+ "type": "string",
+ "title": "Display Name"
+ },
+ "priority": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Name"
+ "title": "Priority"
},
- "description": {
+ "documentation": {
+ "type": "string",
+ "title": "Documentation",
+ "default": ""
+ },
+ "minimized": {
+ "type": "boolean",
+ "title": "Minimized",
+ "default": false
+ },
+ "custom_fields": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Custom Fields"
+ },
+ "output_types": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Output Types",
+ "default": []
+ },
+ "full_path": {
"anyOf": [
{
"type": "string"
@@ -7552,33 +10512,67 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Full Path"
+ },
+ "pinned": {
+ "type": "boolean",
+ "title": "Pinned",
+ "default": false
+ },
+ "conditional_paths": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Conditional Paths",
+ "default": []
+ },
+ "frozen": {
+ "type": "boolean",
+ "title": "Frozen",
+ "default": false
+ },
+ "outputs": {
+ "items": {
+ "$ref": "#/components/schemas/Output"
+ },
+ "type": "array",
+ "title": "Outputs",
+ "default": []
+ },
+ "field_order": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Field Order",
+ "default": []
},
- "data": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Data"
+ "beta": {
+ "type": "boolean",
+ "title": "Beta",
+ "default": false
},
- "folder_id": {
+ "legacy": {
+ "type": "boolean",
+ "title": "Legacy",
+ "default": false
+ },
+ "replacement": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Folder Id"
+ "title": "Replacement"
},
- "endpoint_name": {
+ "error": {
"anyOf": [
{
"type": "string"
@@ -7587,20 +10581,74 @@
"type": "null"
}
],
- "title": "Endpoint Name"
+ "title": "Error"
},
- "mcp_enabled": {
+ "edited": {
+ "type": "boolean",
+ "title": "Edited",
+ "default": false
+ },
+ "metadata": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Metadata",
+ "default": {}
+ },
+ "tool_mode": {
+ "type": "boolean",
+ "title": "Tool Mode",
+ "default": false
+ }
+ },
+ "type": "object",
+ "required": [
+ "template",
+ "base_classes"
+ ],
+ "title": "FrontendNodeRequest"
+ },
+ "GraphData": {
+ "properties": {
+ "nodes": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array",
+ "title": "Nodes"
+ },
+ "edges": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array",
+ "title": "Edges"
+ },
+ "viewport": {
"anyOf": [
{
- "type": "boolean"
+ "$ref": "#/components/schemas/ViewPort"
},
{
"type": "null"
}
- ],
- "title": "Mcp Enabled"
+ ]
+ }
+ },
+ "type": "object",
+ "required": [
+ "nodes",
+ "edges"
+ ],
+ "title": "GraphData"
+ },
+ "GraphDumpResponse": {
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/GraphData"
},
- "locked": {
+ "is_component": {
"anyOf": [
{
"type": "boolean"
@@ -7609,9 +10657,9 @@
"type": "null"
}
],
- "title": "Locked"
+ "title": "Is Component"
},
- "action_name": {
+ "name": {
"anyOf": [
{
"type": "string"
@@ -7620,9 +10668,9 @@
"type": "null"
}
],
- "title": "Action Name"
+ "title": "Name"
},
- "action_description": {
+ "description": {
"anyOf": [
{
"type": "string"
@@ -7631,19 +10679,9 @@
"type": "null"
}
],
- "title": "Action Description"
- },
- "access_type": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/AccessTypeEnum"
- },
- {
- "type": "null"
- }
- ]
+ "title": "Description"
},
- "fs_path": {
+ "endpoint_name": {
"anyOf": [
{
"type": "string"
@@ -7652,19 +10690,67 @@
"type": "null"
}
],
- "title": "Fs Path"
+ "title": "Endpoint Name"
}
},
"type": "object",
- "title": "FlowUpdate"
+ "required": [
+ "data"
+ ],
+ "title": "GraphDumpResponse"
},
- "FolderCreate": {
+ "HTTPValidationError": {
"properties": {
- "name": {
+ "detail": {
+ "items": {
+ "$ref": "#/components/schemas/ValidationError"
+ },
+ "type": "array",
+ "title": "Detail"
+ }
+ },
+ "type": "object",
+ "title": "HTTPValidationError"
+ },
+ "HealthResponse": {
+ "properties": {
+ "status": {
"type": "string",
- "title": "Name"
+ "title": "Status",
+ "default": "nok"
},
- "description": {
+ "chat": {
+ "type": "string",
+ "title": "Chat",
+ "default": "error check the server logs"
+ },
+ "db": {
+ "type": "string",
+ "title": "Db",
+ "default": "error check the server logs"
+ }
+ },
+ "type": "object",
+ "title": "HealthResponse"
+ },
+ "InputValueRequest": {
+ "properties": {
+ "components": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Components",
+ "default": []
+ },
+ "input_value": {
"anyOf": [
{
"type": "string"
@@ -7673,65 +10759,107 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Input Value"
},
- "auth_settings": {
+ "session": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Auth Settings",
- "description": "Authentication settings for the folder/project"
+ "title": "Session"
},
- "components_list": {
+ "type": {
"anyOf": [
{
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "type": "array"
+ "type": "string",
+ "enum": [
+ "chat",
+ "text",
+ "any"
+ ]
},
{
"type": "null"
}
],
- "title": "Components List"
+ "title": "Type",
+ "description": "Defines on which components the input value should be applied. 'any' applies to all input components.",
+ "default": "any"
},
- "flows_list": {
+ "client_request_time": {
"anyOf": [
{
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "type": "array"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Flows List"
+ "title": "Client Request Time",
+ "description": "Client-side timestamp in milliseconds when the request was initiated. Used to calculate accurate end-to-end duration."
}
},
+ "additionalProperties": false,
"type": "object",
- "required": [
- "name"
- ],
- "title": "FolderCreate"
+ "title": "InputValueRequest",
+ "examples": [
+ {
+ "components": [
+ "components_id",
+ "Component Name"
+ ],
+ "input_value": "input_value",
+ "session": "session_id"
+ },
+ {
+ "components": [
+ "Component Name"
+ ],
+ "input_value": "input_value"
+ },
+ {
+ "input_value": "input_value"
+ },
+ {
+ "components": [
+ "Component Name"
+ ],
+ "input_value": "input_value",
+ "session": "session_id"
+ },
+ {
+ "input_value": "input_value",
+ "session": "session_id"
+ },
+ {
+ "input_value": "input_value",
+ "type": "chat"
+ },
+ {
+ "input_value": "{\"key\": \"value\"}",
+ "type": "json"
+ }
+ ]
},
- "FolderRead": {
+ "JSONContent": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "KnowledgeBaseInfo": {
"properties": {
+ "id": {
+ "type": "string",
+ "title": "Id"
+ },
"name": {
"type": "string",
"title": "Name"
},
- "description": {
+ "embedding_provider": {
"anyOf": [
{
"type": "string"
@@ -7740,164 +10868,124 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Embedding Provider",
+ "default": "Unknown"
},
- "auth_settings": {
+ "embedding_model": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Auth Settings",
- "description": "Authentication settings for the folder/project"
+ "title": "Embedding Model",
+ "default": "Unknown"
},
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
+ "size": {
+ "type": "integer",
+ "title": "Size",
+ "default": 0
},
- "parent_id": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Parent Id"
+ "words": {
+ "type": "integer",
+ "title": "Words",
+ "default": 0
+ },
+ "characters": {
+ "type": "integer",
+ "title": "Characters",
+ "default": 0
+ },
+ "chunks": {
+ "type": "integer",
+ "title": "Chunks",
+ "default": 0
+ },
+ "avg_chunk_size": {
+ "type": "number",
+ "title": "Avg Chunk Size",
+ "default": 0.0
}
},
"type": "object",
"required": [
- "name",
"id",
- "parent_id"
+ "name"
],
- "title": "FolderRead"
+ "title": "KnowledgeBaseInfo"
},
- "FolderReadWithFlows": {
+ "ListComponentResponse": {
"properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "description": {
+ "id": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Description"
+ "title": "Id"
},
- "auth_settings": {
+ "name": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Auth Settings",
- "description": "Authentication settings for the folder/project"
- },
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
+ "title": "Name"
},
- "parent_id": {
+ "description": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Parent Id"
+ "title": "Description"
},
- "flows": {
- "items": {
- "$ref": "#/components/schemas/FlowRead"
- },
- "type": "array",
- "title": "Flows",
- "default": []
- }
- },
- "type": "object",
- "required": [
- "name",
- "id",
- "parent_id"
- ],
- "title": "FolderReadWithFlows"
- },
- "FolderUpdate": {
- "properties": {
- "name": {
+ "liked_by_count": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Name"
+ "title": "Liked By Count"
},
- "description": {
+ "liked_by_user": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Description"
+ "title": "Liked By User"
},
- "parent_id": {
+ "is_component": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Parent Id"
- },
- "components": {
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "type": "array",
- "title": "Components"
- },
- "flows": {
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "type": "array",
- "title": "Flows"
+ "title": "Is Component"
},
- "auth_settings": {
+ "metadata": {
"anyOf": [
{
"additionalProperties": true,
@@ -7907,92 +10995,48 @@
"type": "null"
}
],
- "title": "Auth Settings"
- }
- },
- "type": "object",
- "title": "FolderUpdate"
- },
- "FolderWithPaginatedFlows": {
- "properties": {
- "folder": {
- "$ref": "#/components/schemas/FolderRead"
- },
- "flows": {
- "$ref": "#/components/schemas/Page_Flow_"
- }
- },
- "type": "object",
- "required": [
- "folder",
- "flows"
- ],
- "title": "FolderWithPaginatedFlows"
- },
- "GraphData": {
- "properties": {
- "nodes": {
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "type": "array",
- "title": "Nodes"
- },
- "edges": {
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "type": "array",
- "title": "Edges"
+ "title": "Metadata",
+ "default": {}
},
- "viewport": {
+ "user_created": {
"anyOf": [
{
- "$ref": "#/components/schemas/ViewPort"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
- ]
- }
- },
- "type": "object",
- "required": [
- "nodes",
- "edges"
- ],
- "title": "GraphData"
- },
- "GraphDumpResponse": {
- "properties": {
- "data": {
- "$ref": "#/components/schemas/GraphData"
+ ],
+ "title": "User Created",
+ "default": {}
},
- "is_component": {
+ "tags": {
"anyOf": [
{
- "type": "boolean"
+ "items": {
+ "$ref": "#/components/schemas/TagResponse"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Is Component"
+ "title": "Tags"
},
- "name": {
+ "downloads_count": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Name"
+ "title": "Downloads Count"
},
- "description": {
+ "last_tested_version": {
"anyOf": [
{
"type": "string"
@@ -8001,67 +11045,46 @@
"type": "null"
}
],
- "title": "Description"
+ "title": "Last Tested Version"
},
- "endpoint_name": {
+ "private": {
"anyOf": [
{
- "type": "string"
+ "type": "boolean"
},
{
"type": "null"
}
],
- "title": "Endpoint Name"
- }
- },
- "type": "object",
- "required": [
- "data"
- ],
- "title": "GraphDumpResponse"
- },
- "HTTPValidationError": {
- "properties": {
- "detail": {
- "items": {
- "$ref": "#/components/schemas/ValidationError"
- },
- "type": "array",
- "title": "Detail"
+ "title": "Private"
}
},
"type": "object",
- "title": "HTTPValidationError"
+ "title": "ListComponentResponse"
},
- "HealthResponse": {
+ "ListComponentResponseModel": {
"properties": {
- "status": {
- "type": "string",
- "title": "Status",
- "default": "nok"
+ "count": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Count",
+ "default": 0
},
- "chat": {
- "type": "string",
- "title": "Chat",
- "default": "error check the server logs"
+ "authorized": {
+ "type": "boolean",
+ "title": "Authorized"
},
- "db": {
- "type": "string",
- "title": "Db",
- "default": "error check the server logs"
- }
- },
- "type": "object",
- "title": "HealthResponse"
- },
- "InputValueRequest": {
- "properties": {
- "components": {
+ "results": {
"anyOf": [
{
"items": {
- "type": "string"
+ "$ref": "#/components/schemas/ListComponentResponse"
},
"type": "array"
},
@@ -8069,107 +11092,68 @@
"type": "null"
}
],
- "title": "Components",
- "default": []
+ "title": "Results"
+ }
+ },
+ "type": "object",
+ "required": [
+ "authorized",
+ "results"
+ ],
+ "title": "ListComponentResponseModel"
+ },
+ "Log": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name"
},
- "input_value": {
+ "message": {
"anyOf": [
{
"type": "string"
},
{
- "type": "null"
- }
- ],
- "title": "Input Value"
- },
- "session": {
- "anyOf": [
+ "additionalProperties": true,
+ "type": "object"
+ },
{
- "type": "string"
+ "items": {},
+ "type": "array"
},
{
- "type": "null"
- }
- ],
- "title": "Session"
- },
- "type": {
- "anyOf": [
+ "type": "integer"
+ },
{
- "type": "string",
- "enum": [
- "chat",
- "text",
- "any"
- ]
+ "type": "number"
},
{
- "type": "null"
- }
- ],
- "title": "Type",
- "description": "Defines on which components the input value should be applied. 'any' applies to all input components.",
- "default": "any"
- },
- "client_request_time": {
- "anyOf": [
+ "type": "boolean"
+ },
{
- "type": "integer"
+ "$ref": "#/components/schemas/BaseModel"
+ },
+ {
+ "$ref": "#/components/schemas/PlaygroundEvent"
},
{
"type": "null"
}
],
- "title": "Client Request Time",
- "description": "Client-side timestamp in milliseconds when the request was initiated. Used to calculate accurate end-to-end duration."
+ "title": "Message"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type"
}
},
- "additionalProperties": false,
"type": "object",
- "title": "InputValueRequest",
- "examples": [
- {
- "components": [
- "components_id",
- "Component Name"
- ],
- "input_value": "input_value",
- "session": "session_id"
- },
- {
- "components": [
- "Component Name"
- ],
- "input_value": "input_value"
- },
- {
- "input_value": "input_value"
- },
- {
- "components": [
- "Component Name"
- ],
- "input_value": "input_value",
- "session": "session_id"
- },
- {
- "input_value": "input_value",
- "session": "session_id"
- },
- {
- "input_value": "input_value",
- "type": "chat"
- },
- {
- "input_value": "{\"key\": \"value\"}",
- "type": "json"
- }
- ]
- },
- "JSONContent": {
- "additionalProperties": true,
- "type": "object"
+ "required": [
+ "name",
+ "message",
+ "type"
+ ],
+ "title": "Log"
},
"MCPInstallRequest": {
"properties": {
@@ -8705,6 +11689,193 @@
"title": "OpenAIResponsesRequest",
"description": "OpenAI-compatible responses request with flow_id as model parameter."
},
+ "Output": {
+ "properties": {
+ "types": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Types",
+ "default": []
+ },
+ "selected": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Selected"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the field."
+ },
+ "hidden": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Hidden"
+ },
+ "display_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Display Name"
+ },
+ "method": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Method"
+ },
+ "value": {
+ "anyOf": [
+ {},
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Value",
+ "default": "__UNDEFINED__"
+ },
+ "cache": {
+ "type": "boolean",
+ "title": "Cache",
+ "default": true
+ },
+ "required_inputs": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Required Inputs"
+ },
+ "allows_loop": {
+ "type": "boolean",
+ "title": "Allows Loop",
+ "default": false
+ },
+ "loop_types": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Loop Types"
+ },
+ "group_outputs": {
+ "type": "boolean",
+ "title": "Group Outputs",
+ "default": false
+ },
+ "options": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/OutputOptions"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "tool_mode": {
+ "type": "boolean",
+ "title": "Tool Mode",
+ "default": true
+ }
+ },
+ "type": "object",
+ "required": [
+ "name"
+ ],
+ "title": "Output"
+ },
+ "OutputOptions": {
+ "properties": {
+ "filter": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Filter"
+ }
+ },
+ "type": "object",
+ "title": "OutputOptions"
+ },
+ "OutputValue": {
+ "properties": {
+ "message": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ErrorLog"
+ },
+ {
+ "$ref": "#/components/schemas/StreamURL"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ }
+ ],
+ "title": "Message"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type"
+ }
+ },
+ "type": "object",
+ "required": [
+ "message",
+ "type"
+ ],
+ "title": "OutputValue"
+ },
"Page_FlowRead_": {
"properties": {
"items": {
@@ -8785,11 +11956,11 @@
],
"title": "Page[Flow]"
},
- "Page_TransactionLogsResponse_": {
+ "Page_TransactionTable_": {
"properties": {
"items": {
"items": {
- "$ref": "#/components/schemas/TransactionLogsResponse"
+ "$ref": "#/components/schemas/TransactionTable"
},
"type": "array",
"title": "Items"
@@ -8823,7 +11994,128 @@
"size",
"pages"
],
- "title": "Page[TransactionLogsResponse]"
+ "title": "Page[TransactionTable]"
+ },
+ "PlaygroundEvent": {
+ "properties": {
+ "properties": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Properties"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "sender_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sender Name"
+ },
+ "content_blocks": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/ContentBlock"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Content Blocks"
+ },
+ "format_type": {
+ "type": "string",
+ "enum": [
+ "default",
+ "error",
+ "warning",
+ "info"
+ ],
+ "title": "Format Type",
+ "default": "default"
+ },
+ "files": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Files"
+ },
+ "text": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Text"
+ },
+ "timestamp": {
+ "type": "string",
+ "title": "Timestamp"
+ },
+ "id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Id"
+ }
+ },
+ "additionalProperties": true,
+ "type": "object",
+ "title": "PlaygroundEvent"
+ },
+ "PromptValidationResponse": {
+ "properties": {
+ "input_variables": {
+ "items": {},
+ "type": "array",
+ "title": "Input Variables"
+ },
+ "frontend_node": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/FrontendNodeRequest-Output"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "type": "object",
+ "required": [
+ "input_variables"
+ ],
+ "title": "PromptValidationResponse"
},
"Properties": {
"properties": {
@@ -8903,6 +12195,33 @@
"type": "object",
"title": "Properties"
},
+ "RegisterRequest": {
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email",
+ "title": "Email"
+ }
+ },
+ "type": "object",
+ "required": [
+ "email"
+ ],
+ "title": "RegisterRequest"
+ },
+ "RegisterResponse": {
+ "properties": {
+ "email": {
+ "type": "string",
+ "title": "Email"
+ }
+ },
+ "type": "object",
+ "required": [
+ "email"
+ ],
+ "title": "RegisterResponse"
+ },
"ResultData": {
"properties": {
"results": {
@@ -9021,6 +12340,10 @@
"type": "object",
"title": "ResultData"
},
+ "ResultDataResponse": {
+ "additionalProperties": true,
+ "type": "object"
+ },
"RunOutputs": {
"properties": {
"inputs": {
@@ -9170,21 +12493,162 @@
"type": "object",
"title": "SimplifiedAPIRequest"
},
- "Source": {
+ "Source": {
+ "properties": {
+ "id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Id",
+ "description": "The id of the source component."
+ },
+ "display_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Display Name",
+ "description": "The display name of the source component."
+ },
+ "source": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Source",
+ "description": "The source of the message. Normally used to display the model name (e.g. 'gpt-4o')"
+ }
+ },
+ "type": "object",
+ "title": "Source"
+ },
+ "StoreComponentCreate": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Description"
+ },
+ "data": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Data"
+ },
+ "tags": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Tags"
+ },
+ "parent": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Parent"
+ },
+ "is_component": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Is Component"
+ },
+ "last_tested_version": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Last Tested Version"
+ },
+ "private": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Private",
+ "default": true
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "description",
+ "data",
+ "tags",
+ "is_component"
+ ],
+ "title": "StoreComponentCreate"
+ },
+ "StreamURL": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "title": "Location"
+ }
+ },
+ "type": "object",
+ "required": [
+ "location"
+ ],
+ "title": "StreamURL"
+ },
+ "TagResponse": {
"properties": {
"id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id",
- "description": "The id of the source component."
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
},
- "display_name": {
+ "name": {
"anyOf": [
{
"type": "string"
@@ -9193,40 +12657,72 @@
"type": "null"
}
],
- "title": "Display Name",
- "description": "The display name of the source component."
+ "title": "Name"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "name"
+ ],
+ "title": "TagResponse"
+ },
+ "TaskStatusResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "title": "Status"
},
- "source": {
+ "result": {
"anyOf": [
- {
- "type": "string"
- },
+ {},
{
"type": "null"
}
],
- "title": "Source",
- "description": "The source of the message. Normally used to display the model name (e.g. 'gpt-4o')"
+ "title": "Result"
}
},
"type": "object",
- "title": "Source"
+ "required": [
+ "status"
+ ],
+ "title": "TaskStatusResponse",
+ "description": "Task status response schema."
},
"TextContent": {
"additionalProperties": true,
"type": "object"
},
+ "Token": {
+ "properties": {
+ "access_token": {
+ "type": "string",
+ "title": "Access Token"
+ },
+ "refresh_token": {
+ "type": "string",
+ "title": "Refresh Token"
+ },
+ "token_type": {
+ "type": "string",
+ "title": "Token Type"
+ }
+ },
+ "type": "object",
+ "required": [
+ "access_token",
+ "refresh_token",
+ "token_type"
+ ],
+ "title": "Token"
+ },
"ToolContent": {
"additionalProperties": true,
"type": "object"
},
- "TransactionLogsResponse": {
+ "TransactionTable": {
"properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
- },
"timestamp": {
"type": "string",
"format": "date-time",
@@ -9260,16 +12756,43 @@
"status": {
"type": "string",
"title": "Status"
+ },
+ "error": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error"
+ },
+ "flow_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Flow Id"
+ },
+ "id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Id"
}
},
"type": "object",
"required": [
- "id",
"vertex_id",
- "status"
+ "status",
+ "flow_id"
],
- "title": "TransactionLogsResponse",
- "description": "Transaction response model for logs view - excludes error and flow_id fields."
+ "title": "TransactionTable"
},
"Tweaks": {
"additionalProperties": {
@@ -9298,47 +12821,152 @@
}
]
},
- "UploadFileResponse": {
+ "UnmaskedApiKeyRead": {
"properties": {
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name"
+ },
+ "last_used_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Last Used At"
+ },
+ "total_uses": {
+ "type": "integer",
+ "title": "Total Uses",
+ "default": 0
+ },
+ "is_active": {
+ "type": "boolean",
+ "title": "Is Active",
+ "default": true
+ },
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
- "name": {
+ "api_key": {
"type": "string",
- "title": "Name"
+ "title": "Api Key"
},
- "path": {
+ "user_id": {
"type": "string",
- "format": "path",
- "title": "Path"
+ "format": "uuid",
+ "title": "User Id"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "api_key",
+ "user_id"
+ ],
+ "title": "UnmaskedApiKeyRead"
+ },
+ "UpdateCustomComponentRequest": {
+ "properties": {
+ "code": {
+ "type": "string",
+ "title": "Code"
},
- "size": {
- "type": "integer",
- "title": "Size"
+ "frontend_node": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Frontend Node"
},
- "provider": {
+ "field": {
+ "type": "string",
+ "title": "Field"
+ },
+ "field_value": {
"anyOf": [
{
"type": "string"
},
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
{
"type": "null"
}
],
- "title": "Provider"
+ "title": "Field Value"
+ },
+ "template": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Template"
+ },
+ "tool_mode": {
+ "type": "boolean",
+ "title": "Tool Mode",
+ "default": false
}
},
"type": "object",
"required": [
- "id",
- "name",
- "path",
- "size"
+ "code",
+ "field",
+ "template"
+ ],
+ "title": "UpdateCustomComponentRequest"
+ },
+ "UploadFileResponse": {
+ "properties": {
+ "flowId": {
+ "type": "string",
+ "title": "Flowid"
+ },
+ "file_path": {
+ "type": "string",
+ "format": "path",
+ "title": "File Path"
+ }
+ },
+ "type": "object",
+ "required": [
+ "flowId",
+ "file_path"
],
"title": "UploadFileResponse",
- "description": "File upload response schema."
+ "description": "Upload file response schema."
},
"UserCreate": {
"properties": {
@@ -9549,6 +13177,38 @@
"type": "object",
"title": "UserUpdate"
},
+ "UsersLikesResponse": {
+ "properties": {
+ "likes_count": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Likes Count"
+ },
+ "liked_by_user": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Liked By User"
+ }
+ },
+ "type": "object",
+ "required": [
+ "likes_count",
+ "liked_by_user"
+ ],
+ "title": "UsersLikesResponse"
+ },
"UsersResponse": {
"properties": {
"total_count": {
@@ -9565,10 +13225,50 @@
},
"type": "object",
"required": [
- "total_count",
- "users"
+ "total_count",
+ "users"
+ ],
+ "title": "UsersResponse"
+ },
+ "ValidatePromptRequest": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "template": {
+ "type": "string",
+ "title": "Template"
+ },
+ "custom_fields": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Custom Fields"
+ },
+ "frontend_node": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/FrontendNodeRequest-Input"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "template"
],
- "title": "UsersResponse"
+ "title": "ValidatePromptRequest"
},
"ValidationError": {
"properties": {
@@ -9603,330 +13303,219 @@
],
"title": "ValidationError"
},
- "VertexBuildMapModel": {
- "properties": {
- "vertex_builds": {
- "additionalProperties": {
- "items": {
- "$ref": "#/components/schemas/VertexBuildTable"
- },
- "type": "array"
- },
- "type": "object",
- "title": "Vertex Builds"
- }
- },
- "type": "object",
- "required": [
- "vertex_builds"
- ],
- "title": "VertexBuildMapModel"
- },
- "VertexBuildTable": {
+ "VariableCreate": {
"properties": {
- "timestamp": {
- "type": "string",
- "format": "date-time",
- "title": "Timestamp"
- },
- "id": {
+ "name": {
"type": "string",
- "title": "Id"
- },
- "data": {
- "additionalProperties": true,
- "type": "object",
- "title": "Data"
- },
- "artifacts": {
- "additionalProperties": true,
- "type": "object",
- "title": "Artifacts"
+ "title": "Name",
+ "description": "Name of the variable"
},
- "params": {
+ "value": {
"type": "string",
- "title": "Params"
+ "title": "Value",
+ "description": "Encrypted value of the variable"
},
- "valid": {
- "type": "boolean",
- "title": "Valid"
+ "default_fields": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Default Fields"
},
- "flow_id": {
- "type": "string",
- "format": "uuid",
- "title": "Flow Id"
+ "type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Type",
+ "description": "Type of the variable"
},
- "job_id": {
+ "created_at": {
"anyOf": [
{
"type": "string",
- "format": "uuid"
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Job Id"
+ "title": "Created At",
+ "description": "Creation time of the variable"
},
- "build_id": {
+ "updated_at": {
"anyOf": [
{
"type": "string",
- "format": "uuid"
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Build Id"
- }
- },
- "type": "object",
- "required": [
- "id",
- "valid",
- "flow_id"
- ],
- "title": "VertexBuildTable"
- },
- "ViewPort": {
- "properties": {
- "x": {
- "type": "number",
- "title": "X"
- },
- "y": {
- "type": "number",
- "title": "Y"
- },
- "zoom": {
- "type": "number",
- "title": "Zoom"
+ "title": "Updated At",
+ "description": "Creation time of the variable"
}
},
"type": "object",
"required": [
- "x",
- "y",
- "zoom"
+ "name",
+ "value",
+ "default_fields"
],
- "title": "ViewPort"
+ "title": "VariableCreate"
},
- "WorkflowExecutionRequest": {
+ "VariableRead": {
"properties": {
- "background": {
- "type": "boolean",
- "title": "Background",
- "default": false
- },
- "stream": {
- "type": "boolean",
- "title": "Stream",
- "default": false
- },
- "flow_id": {
+ "id": {
"type": "string",
- "title": "Flow Id"
+ "format": "uuid",
+ "title": "Id"
},
- "inputs": {
+ "name": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Inputs",
- "description": "Component-specific inputs in flat format: 'component_id.param_name': value"
- }
- },
- "additionalProperties": false,
- "type": "object",
- "required": [
- "flow_id"
- ],
- "title": "WorkflowExecutionRequest",
- "description": "Request schema for workflow execution.",
- "examples": [
- {
- "background": false,
- "flow_id": "flow_67ccd2be17f0819081ff3bb2cf6508e60bb6a6b452d3795b",
- "inputs": {
- "ChatInput-abc.input_value": "Hello, how can you help me today?",
- "ChatInput-abc.session_id": "session-123",
- "LLM-xyz.max_tokens": 100,
- "LLM-xyz.temperature": 0.7,
- "OpenSearch-def.opensearch_url": "https://opensearch:9200"
- },
- "stream": false
- },
- {
- "background": true,
- "flow_id": "flow_67ccd2be17f0819081ff3bb2cf6508e60bb6a6b452d3795b",
- "inputs": {
- "ChatInput-abc.input_value": "Process this in the background"
- },
- "stream": false
+ "title": "Name",
+ "description": "Name of the variable"
},
- {
- "background": false,
- "flow_id": "flow_67ccd2be17f0819081ff3bb2cf6508e60bb6a6b452d3795b",
- "inputs": {
- "ChatInput-abc.input_value": "Stream this conversation"
- },
- "stream": true
- }
- ]
- },
- "WorkflowStopRequest": {
- "properties": {
- "job_id": {
+ "type": {
"anyOf": [
{
"type": "string"
},
{
- "type": "string",
- "format": "uuid"
+ "type": "null"
}
],
- "title": "Job Id"
- }
- },
- "type": "object",
- "required": [
- "job_id"
- ],
- "title": "WorkflowStopRequest",
- "description": "Request schema for stopping workflow."
- },
- "WorkflowStopResponse": {
- "properties": {
- "job_id": {
+ "title": "Type",
+ "description": "Type of the variable"
+ },
+ "value": {
"anyOf": [
{
"type": "string"
},
{
- "type": "string",
- "format": "uuid"
+ "type": "null"
}
],
- "title": "Job Id"
+ "title": "Value",
+ "description": "Encrypted value of the variable"
},
- "message": {
+ "default_fields": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Message"
- }
- },
- "type": "object",
- "required": [
- "job_id"
- ],
- "title": "WorkflowStopResponse",
- "description": "Response schema for stopping workflow."
- },
- "langflow__api__v1__schemas__UploadFileResponse": {
- "properties": {
- "flowId": {
- "type": "string",
- "title": "Flowid"
- },
- "file_path": {
- "type": "string",
- "format": "path",
- "title": "File Path"
+ "title": "Default Fields",
+ "description": "Default fields for the variable"
}
},
"type": "object",
"required": [
- "flowId",
- "file_path"
+ "id"
],
- "title": "UploadFileResponse",
- "description": "Upload file response schema."
+ "title": "VariableRead"
},
- "lfx__utils__schemas__File": {
+ "VariableUpdate": {
"properties": {
- "path": {
+ "id": {
"type": "string",
- "title": "Path"
+ "format": "uuid",
+ "title": "Id"
},
"name": {
- "type": "string",
- "title": "Name"
- },
- "type": {
- "type": "string",
- "title": "Type"
- }
- },
- "type": "object",
- "required": [
- "path",
- "name",
- "type"
- ],
- "title": "File",
- "description": "File schema."
- },
- "ComponentOutput": {
- "description": "Component output schema.",
- "properties": {
- "type": {
- "description": "Type of the component output (e.g., 'message', 'data', 'tool', 'text')",
- "title": "Type",
- "type": "string"
- },
- "status": {
- "$ref": "#/components/schemas/JobStatus"
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name",
+ "description": "Name of the variable"
},
- "content": {
+ "value": {
"anyOf": [
- {},
+ {
+ "type": "string"
+ },
{
"type": "null"
}
],
- "title": "Content"
+ "title": "Value",
+ "description": "Encrypted value of the variable"
},
- "metadata": {
+ "default_fields": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Metadata"
+ "title": "Default Fields",
+ "description": "Default fields for the variable"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id"
+ ],
+ "title": "VariableUpdate"
+ },
+ "VertexBuildMapModel": {
+ "properties": {
+ "vertex_builds": {
+ "additionalProperties": {
+ "items": {
+ "$ref": "#/components/schemas/VertexBuildTable"
+ },
+ "type": "array"
+ },
+ "type": "object",
+ "title": "Vertex Builds"
}
},
+ "type": "object",
"required": [
- "type",
- "status"
+ "vertex_builds"
],
- "title": "ComponentOutput",
- "type": "object"
+ "title": "VertexBuildMapModel"
},
- "ErrorDetail": {
- "description": "Error detail schema.",
+ "VertexBuildResponse": {
"properties": {
- "error": {
- "title": "Error",
- "type": "string"
- },
- "code": {
+ "id": {
"anyOf": [
{
"type": "string"
@@ -9935,304 +13524,264 @@
"type": "null"
}
],
- "title": "Code"
+ "title": "Id"
},
- "details": {
+ "inactivated_vertices": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Details"
- }
- },
- "required": [
- "error"
- ],
- "title": "ErrorDetail",
- "type": "object"
- },
- "JobStatus": {
- "description": "Job execution status.",
- "enum": [
- "queued",
- "in_progress",
- "completed",
- "failed",
- "cancelled",
- "timed_out"
- ],
- "title": "JobStatus",
- "type": "string"
- },
- "ErrorDetail_1": {
- "description": "Error detail schema.",
- "properties": {
- "error": {
- "title": "Error",
- "type": "string"
+ "title": "Inactivated Vertices"
},
- "code": {
+ "next_vertices_ids": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Code"
+ "title": "Next Vertices Ids"
},
- "details": {
+ "top_level_vertices": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Details"
- }
- },
- "required": [
- "error"
- ],
- "title": "ErrorDetail",
- "type": "object"
- },
- "JobStatus_1": {
- "description": "Job execution status.",
- "enum": [
- "queued",
- "in_progress",
- "completed",
- "failed",
- "cancelled",
- "timed_out"
- ],
- "title": "JobStatus",
- "type": "string"
- },
- "ComponentOutput_1": {
- "description": "Component output schema.",
- "properties": {
- "type": {
- "description": "Type of the component output (e.g., 'message', 'data', 'tool', 'text')",
- "title": "Type",
- "type": "string"
+ "title": "Top Level Vertices"
},
- "status": {
- "$ref": "#/components/schemas/JobStatus"
+ "valid": {
+ "type": "boolean",
+ "title": "Valid"
},
- "content": {
+ "params": {
"anyOf": [
{},
{
"type": "null"
}
],
- "title": "Content"
+ "title": "Params"
},
- "metadata": {
+ "data": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "timestamp": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Metadata"
+ "title": "Timestamp"
}
},
+ "type": "object",
"required": [
- "type",
- "status"
+ "valid",
+ "data"
],
- "title": "ComponentOutput",
- "type": "object"
+ "title": "VertexBuildResponse"
},
- "ErrorDetail_2": {
- "description": "Error detail schema.",
+ "VertexBuildTable": {
"properties": {
- "error": {
- "title": "Error",
- "type": "string"
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp"
},
- "code": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Code"
+ "id": {
+ "type": "string",
+ "title": "Id"
+ },
+ "data": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Data"
+ },
+ "artifacts": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Artifacts"
+ },
+ "params": {
+ "type": "string",
+ "title": "Params"
+ },
+ "valid": {
+ "type": "boolean",
+ "title": "Valid"
+ },
+ "flow_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Flow Id"
},
- "details": {
+ "build_id": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Details"
+ "title": "Build Id"
}
},
+ "type": "object",
"required": [
- "error"
+ "id",
+ "valid",
+ "flow_id"
],
- "title": "ErrorDetail",
- "type": "object"
+ "title": "VertexBuildTable"
},
- "JobStatus_2": {
- "description": "Job execution status.",
- "enum": [
- "queued",
- "in_progress",
- "completed",
- "failed",
- "cancelled",
- "timed_out"
- ],
- "title": "JobStatus",
- "type": "string"
- },
- "WorkflowExecutionResponse": {
- "description": "Synchronous workflow execution response.",
+ "VerticesOrderResponse": {
"properties": {
- "flow_id": {
- "title": "Flow Id",
- "type": "string"
- },
- "job_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "format": "uuid",
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Job Id"
- },
- "object": {
- "const": "response",
- "default": "response",
- "title": "Object",
- "type": "string"
- },
- "created_timestamp": {
- "title": "Created Timestamp",
- "type": "string"
+ "ids": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Ids"
},
- "status": {
- "$ref": "#/components/schemas/JobStatus"
+ "run_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Run Id"
},
- "errors": {
- "default": [],
+ "vertices_to_run": {
"items": {
- "$ref": "#/components/schemas/ErrorDetail"
+ "type": "string"
},
- "title": "Errors",
- "type": "array"
+ "type": "array",
+ "title": "Vertices To Run"
+ }
+ },
+ "type": "object",
+ "required": [
+ "ids",
+ "run_id",
+ "vertices_to_run"
+ ],
+ "title": "VerticesOrderResponse"
+ },
+ "ViewPort": {
+ "properties": {
+ "x": {
+ "type": "number",
+ "title": "X"
},
- "inputs": {
- "additionalProperties": true,
- "default": {},
- "title": "Inputs",
- "type": "object"
+ "y": {
+ "type": "number",
+ "title": "Y"
},
- "outputs": {
- "additionalProperties": {
- "$ref": "#/components/schemas/ComponentOutput"
- },
- "default": {},
- "title": "Outputs",
- "type": "object"
+ "zoom": {
+ "type": "number",
+ "title": "Zoom"
}
},
+ "type": "object",
"required": [
- "flow_id",
- "status"
+ "x",
+ "y",
+ "zoom"
],
- "title": "WorkflowExecutionResponse",
- "type": "object"
+ "title": "ViewPort"
},
- "WorkflowJobResponse": {
- "description": "Background job response.",
+ "langflow__api__schemas__UploadFileResponse": {
"properties": {
- "job_id": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "path": {
+ "type": "string",
+ "format": "path",
+ "title": "Path"
+ },
+ "size": {
+ "type": "integer",
+ "title": "Size"
+ },
+ "provider": {
"anyOf": [
{
"type": "string"
},
{
- "format": "uuid",
- "type": "string"
+ "type": "null"
}
],
- "title": "Job Id"
- },
- "flow_id": {
- "title": "Flow Id",
- "type": "string"
- },
- "object": {
- "const": "job",
- "default": "job",
- "title": "Object",
- "type": "string"
- },
- "created_timestamp": {
- "title": "Created Timestamp",
- "type": "string"
- },
- "status": {
- "$ref": "#/components/schemas/JobStatus_1"
+ "title": "Provider"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "name",
+ "path",
+ "size"
+ ],
+ "title": "UploadFileResponse",
+ "description": "File upload response schema."
+ },
+ "lfx__utils__schemas__File": {
+ "properties": {
+ "path": {
+ "type": "string",
+ "title": "Path"
},
- "links": {
- "additionalProperties": {
- "type": "string"
- },
- "title": "Links",
- "type": "object"
+ "name": {
+ "type": "string",
+ "title": "Name"
},
- "errors": {
- "default": [],
- "items": {
- "$ref": "#/components/schemas/ErrorDetail_1"
- },
- "title": "Errors",
- "type": "array"
+ "type": {
+ "type": "string",
+ "title": "Type"
}
},
+ "type": "object",
"required": [
- "job_id",
- "flow_id",
- "status"
+ "path",
+ "name",
+ "type"
],
- "title": "WorkflowJobResponse",
- "type": "object"
+ "title": "File",
+ "description": "File schema."
}
},
"securitySchemes": {
- "OAuth2PasswordBearerCookie": {
+ "OAuth2PasswordBearer": {
"type": "oauth2",
"flows": {
"password": {
@@ -10253,4 +13802,4 @@
}
}
}
-}
\ No newline at end of file
+}