{
"openapi": "3.1.0",
"info": {
"title": "Langflow",
"version": "1.8.0"
},
"$defs": {
"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": "#/$defs/JobStatus"
},
"content": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Content"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata"
}
},
"required": [
"type",
"status"
],
"title": "ComponentOutput",
"type": "object"
},
"ErrorDetail": {
"description": "Error detail schema.",
"properties": {
"error": {
"title": "Error",
"type": "string"
},
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code"
},
"details": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"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"
}
},
"paths": {
"/api/v1/build/{flow_id}/flow": {
"post": {
"tags": [
"Chat"
],
"summary": "Build Flow",
"description": "Build and process a flow, returning a job ID for event polling.
This endpoint requires authentication through the CurrentActiveUser dependency.
For public flows that don't require authentication, use the /build_public_tmp/flow_id/flow endpoint.
Args:
flow_id: UUID of the flow to build
background_tasks: Background tasks manager
inputs: Optional input values for the flow
data: Optional flow data
files: Optional files to include
stop_component_id: Optional ID of component to stop at
start_component_id: Optional ID of component to start from
log_builds: Whether to log the build process
current_user: The authenticated user
queue_service: Queue service for job management
flow_name: Optional name for the flow
event_delivery: Optional event delivery type - default is streaming
Returns:
Dict with job_id that can be used to poll for build status",
"operationId": "build_flow_api_v1_build__flow_id__flow_post",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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"
}
},
{
"name": "log_builds",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Log Builds"
}
},
{
"name": "flow_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Flow Name"
}
},
{
"name": "event_delivery",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/EventDeliveryType",
"default": "polling"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_build_flow_api_v1_build__flow_id__flow_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/build/{job_id}/events": {
"get": {
"tags": [
"Chat"
],
"summary": "Get Build Events",
"description": "Get events for a specific build job.
Requires authentication to prevent unauthorized access to build events.",
"operationId": "get_build_events_api_v1_build__job_id__events_get",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Job Id"
}
},
{
"name": "event_delivery",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/EventDeliveryType",
"default": "streaming"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/build/{job_id}/cancel": {
"post": {
"tags": [
"Chat"
],
"summary": "Cancel Build",
"description": "Cancel a specific build job.
Requires authentication to prevent unauthorized build cancellation.",
"operationId": "cancel_build_api_v1_build__job_id__cancel_post",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Job Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelFlowResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/build_public_tmp/{flow_id}/flow": {
"post": {
"tags": [
"Chat"
],
"summary": "Build Public Tmp",
"description": "Build a public flow without requiring authentication.
This endpoint is specifically for public flows that don't require authentication.
It uses a client_id cookie to create a deterministic flow ID for tracking purposes.
The endpoint:
1. Verifies the requested flow is marked as public in the database
2. Creates a deterministic UUID based on client_id and flow_id
3. Uses the flow owner's permissions to build the flow
Requirements:
- The flow must be marked as PUBLIC in the database
- The request must include a client_id cookie
Args:
flow_id: UUID of the public flow to build
background_tasks: Background tasks manager
inputs: Optional input values for the flow
data: Optional flow data
files: Optional files to include
stop_component_id: Optional ID of component to stop at
start_component_id: Optional ID of component to start from
log_builds: Whether to log the build process
flow_name: Optional name for the flow
request: FastAPI request object (needed for cookie access)
queue_service: Queue service for job management
event_delivery: Optional event delivery type - default is streaming
Returns:
Dict with job_id that can be used to poll for build status",
"operationId": "build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post",
"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"
}
},
{
"name": "log_builds",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"title": "Log Builds"
}
},
{
"name": "flow_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Flow Name"
}
},
{
"name": "event_delivery",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/EventDeliveryType",
"default": "polling"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/all": {
"get": {
"tags": [
"Base"
],
"summary": "Get All",
"description": "Retrieve all component types with compression for better performance.
Returns a compressed response containing all available component types.",
"operationId": "get_all_api_v1_all_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
]
}
},
"/api/v1/run/{flow_id_or_name}": {
"post": {
"tags": [
"Base"
],
"summary": "Simplified Run Flow",
"description": "Executes a specified flow by ID with support for streaming and telemetry (API key auth).
This endpoint executes a flow identified by ID or name, with options for streaming the response
and tracking execution metrics. It handles both streaming and non-streaming execution modes.
This endpoint uses API key authentication (Bearer token).
Args:
background_tasks (BackgroundTasks): FastAPI background task manager
flow (FlowRead | None): The flow to execute, loaded via dependency
input_request (SimplifiedAPIRequest | None): Input parameters for the flow
stream (bool): Whether to stream the response
api_key_user (UserRead): Authenticated user from API key
context (dict | None): Optional context to pass to the flow
http_request (Request): The incoming HTTP request for extracting global variables
Returns:
Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results
or a RunResponse with the complete execution results
Raises:
HTTPException: For flow not found (404) or invalid input (400)
APIException: For internal execution errors (500)
Notes:
- Supports both streaming and non-streaming execution modes
- Tracks execution time and success/failure via telemetry
- Handles graceful client disconnection in streaming mode
- Provides detailed error handling with appropriate HTTP status codes
- Extracts global variables from HTTP headers with prefix X-LANGFLOW-GLOBAL-VAR-*
- Merges extracted variables with the context parameter as \"request_variables\"
- In streaming mode, uses EventManager to handle events:
- \"add_message\": New messages during execution
- \"token\": Individual tokens during streaming
- \"end\": Final execution result
- Authentication: Requires API key (Bearer token)",
"operationId": "simplified_run_flow_api_v1_run__flow_id_or_name__post",
"security": [
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "flow_id_or_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Flow Id Or Name"
}
},
{
"name": "stream",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Stream"
}
},
{
"name": "user_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "User Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_simplified_run_flow_api_v1_run__flow_id_or_name__post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/webhook/{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",
"parameters": [
{
"name": "flow_id_or_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Flow Id Or Name"
}
},
{
"name": "user_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "User Id"
}
}
],
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"title": "Response Webhook Run Flow Api V1 Webhook Flow Id Or Name Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/run/advanced/{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": [
{
"name": "flow_id_or_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Flow Id Or Name"
}
},
{
"name": "user_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "User Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/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": {
"tags": [
"Base"
],
"summary": "Get Config",
"description": "Retrieve application configuration settings.
Returns different configuration based on authentication status:
- Authenticated users: Full ConfigResponse with all settings
- Unauthenticated users: PublicConfigResponse with limited, safe-to-expose settings
Args:
user: The authenticated user, or None if unauthenticated.
Returns:
ConfigResponse | PublicConfigResponse: Configuration settings appropriate for the user's auth status.
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": {
"anyOf": [
{
"$ref": "#/components/schemas/ConfigResponse"
},
{
"$ref": "#/components/schemas/PublicConfigResponse"
}
],
"title": "Response Get Config Api V1 Config Get"
}
}
}
}
},
"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": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"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,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 50,
"title": "Size"
}
}
],
"responses": {
"200": {
"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"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Flows"
],
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/flows/{flow_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": []
}
],
"parameters": [
{
"name": "flow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Flow Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"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": []
}
],
"parameters": [
{
"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/FlowUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"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"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/flows/public_flow/{flow_id}": {
"get": {
"tags": [
"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": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Flow Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/flows/batch/": {
"post": {
"tags": [
"Flows"
],
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "folder_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Folder Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_file_api_v1_flows_upload__post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowRead"
},
"title": "Response Upload File Api V1 Flows Upload Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/flows/download/": {
"post": {
"tags": [
"Flows"
],
"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": "array",
"title": "Flow 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/v1/flows/basic_examples/": {
"get": {
"tags": [
"Flows"
],
"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": {
"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"
}
}
}
}
}
}
},
"/api/v1/users/": {
"post": {
"tags": [
"Users"
],
"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": {
"schema": {
"$ref": "#/components/schemas/UserCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Users"
],
"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": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"title": "Skip"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 10,
"title": "Limit"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsersResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/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}": {
"patch": {
"tags": [
"Users"
],
"summary": "Patch User",
"description": "Update an existing user's data.",
"operationId": "patch_user_api_v1_users__user_id__patch",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"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"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Users"
],
"summary": "Delete User",
"description": "Delete a user from the database.",
"operationId": "delete_user_api_v1_users__user_id__delete",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"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"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/files/upload/{flow_id}": {
"post": {
"tags": [
"Files"
],
"summary": "Upload File",
"operationId": "upload_file_api_v1_files_upload__flow_id__post",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "flow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Flow Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_file_api_v1_files_upload__flow_id__post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/langflow__api__v1__schemas__UploadFileResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/files/download/{flow_id}/{file_name}": {
"get": {
"tags": [
"Files"
],
"summary": "Download File",
"operationId": "download_file_api_v1_files_download__flow_id___file_name__get",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"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"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/files/images/{flow_id}/{file_name}": {
"get": {
"tags": [
"Files"
],
"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,
"schema": {
"type": "string",
"format": "uuid",
"title": "Flow Id"
}
},
{
"name": "file_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Name"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/files/profile_pictures/{folder_name}/{file_name}": {
"get": {
"tags": [
"Files"
],
"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": [
{
"name": "folder_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Folder Name"
}
},
{
"name": "file_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Name"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/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}": {
"get": {
"tags": [
"Files"
],
"summary": "List Files",
"operationId": "list_files_api_v1_files_list__flow_id__get",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "flow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Flow Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/files/delete/{flow_id}/{file_name}": {
"delete": {
"tags": [
"Files"
],
"summary": "Delete File",
"operationId": "delete_file_api_v1_files_delete__flow_id___file_name__delete",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"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"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitor/builds": {
"get": {
"tags": [
"Monitor"
],
"summary": "Get Vertex Builds",
"operationId": "get_vertex_builds_api_v1_monitor_builds_get",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "flow_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Flow Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VertexBuildMapModel"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Monitor"
],
"summary": "Delete Vertex Builds",
"operationId": "delete_vertex_builds_api_v1_monitor_builds_delete",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "flow_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Flow Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitor/messages/sessions": {
"get": {
"tags": [
"Monitor"
],
"summary": "Get Message Sessions",
"operationId": "get_message_sessions_api_v1_monitor_messages_sessions_get",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "flow_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Response Get Message Sessions Api V1 Monitor Messages Sessions Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitor/messages": {
"get": {
"tags": [
"Monitor"
],
"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": [
{
"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"
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "timestamp",
"title": "Order By"
}
}
],
"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"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Monitor"
],
"summary": "Delete Messages",
"operationId": "delete_messages_api_v1_monitor_messages_delete",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"title": "Message Ids"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitor/messages/{message_id}": {
"put": {
"tags": [
"Monitor"
],
"summary": "Update Message",
"operationId": "update_message_api_v1_monitor_messages__message_id__put",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"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"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitor/messages/session/{old_session_id}": {
"patch": {
"tags": [
"Monitor"
],
"summary": "Update Session Id",
"operationId": "update_session_id_api_v1_monitor_messages_session__old_session_id__patch",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "old_session_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"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": {
"200": {
"description": "Successful Response",
"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"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitor/messages/session/{session_id}": {
"delete": {
"tags": [
"Monitor"
],
"summary": "Delete Messages Session",
"operationId": "delete_messages_session_api_v1_monitor_messages_session__session_id__delete",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "session_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Session Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitor/transactions": {
"get": {
"tags": [
"Monitor"
],
"summary": "Get Transactions",
"operationId": "get_transactions_api_v1_monitor_transactions_get",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "flow_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"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"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_TransactionLogsResponse_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitor/traces": {
"get": {
"tags": [
"Traces"
],
"summary": "Get Traces",
"description": "Get list of traces for a flow.
Args:
current_user: Authenticated user (required for authorization)
flow_id: Filter by flow ID
session_id: Filter by session ID
status: Filter by trace status
query: Search query for trace name/id/session id
start_time: Filter traces starting on/after this time (ISO)
end_time: Filter traces starting on/before this time (ISO)
page: Page number (1-based)
size: Page size
Returns:
List of traces",
"operationId": "get_traces_api_v1_monitor_traces_get",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "flow_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"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": "status",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/SpanStatus"
},
{
"type": "null"
}
],
"title": "Status"
}
},
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
}
},
{
"name": "start_time",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Time"
}
},
{
"name": "end_time",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Time"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 1,
"title": "Page"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"default": 50,
"title": "Size"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceListResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Traces"
],
"summary": "Delete Traces By Flow",
"description": "Delete all traces for a flow.
Args:
flow_id: The ID of the flow whose traces should be deleted.
current_user: The authenticated user (required for authorization).",
"operationId": "delete_traces_by_flow_api_v1_monitor_traces_delete",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "flow_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Flow Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/monitor/traces/{trace_id}": {
"get": {
"tags": [
"Traces"
],
"summary": "Get Trace",
"description": "Get a single trace with its hierarchical span tree.
Args:
trace_id: The ID of the trace to retrieve.
current_user: The authenticated user (required for authorization).
Returns:
TraceRead containing the trace and its hierarchical span tree.",
"operationId": "get_trace_api_v1_monitor_traces__trace_id__get",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "trace_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Trace Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Traces"
],
"summary": "Delete Trace",
"description": "Delete a trace and all its spans.
Args:
trace_id: The ID of the trace to delete.
current_user: The authenticated user (required for authorization).",
"operationId": "delete_trace_api_v1_monitor_traces__trace_id__delete",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "trace_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Trace Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/projects/": {
"get": {
"tags": [
"Projects"
],
"summary": "Read Projects",
"operationId": "read_projects_api_v1_projects__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"
}
}
}
}
},
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
]
},
"post": {
"tags": [
"Projects"
],
"summary": "Create Project",
"operationId": "create_project_api_v1_projects__post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
]
}
},
"/api/v1/projects/{project_id}": {
"get": {
"tags": [
"Projects"
],
"summary": "Read Project",
"operationId": "read_project_api_v1_projects__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"
}
},
{
"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"
}
}
],
"responses": {
"200": {
"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"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Projects"
],
"summary": "Update Project",
"operationId": "update_project_api_v1_projects__project_id__patch",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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/FolderUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderRead"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Projects"
],
"summary": "Delete Project",
"operationId": "delete_project_api_v1_projects__project_id__delete",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Project Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/projects/download/{project_id}": {
"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"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/projects/upload/": {
"post": {
"tags": [
"Projects"
],
"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"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/FlowRead"
},
"type": "array",
"title": "Response Upload File Api V1 Projects Upload Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
]
}
},
"/api/v1/starter-projects/": {
"get": {
"tags": [
"Flows"
],
"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": []
},
{
"API key query": []
},
{
"API key header": []
}
]
}
},
"/api/v1/mcp/sse": {
"get": {
"tags": [
"mcp"
],
"summary": "Handle Sse",
"operationId": "handle_sse_api_v1_mcp_sse_get",
"responses": {
"200": {
"description": "Successful Response"
}
},
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
]
},
"head": {
"tags": [
"mcp"
],
"summary": "Im Alive",
"operationId": "im_alive_api_v1_mcp_sse_head",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v1/mcp/": {
"post": {
"tags": [
"mcp"
],
"summary": "Handle Messages",
"operationId": "handle_messages_api_v1_mcp__post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/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_v1_mcp_streamable_delete",
"responses": {
"200": {
"description": "Successful Response"
}
},
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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_v1_mcp_streamable_delete",
"responses": {
"200": {
"description": "Successful Response"
}
},
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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_v1_mcp_streamable_delete",
"responses": {
"200": {
"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",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/v1/mcp/project/{project_id}": {
"get": {
"tags": [
"mcp_projects"
],
"summary": "List Project Tools",
"description": "List project MCP tools.",
"operationId": "list_project_tools_api_v1_mcp_project__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"
}
},
{
"name": "mcp_enabled",
"in": "query",
"required": false,
"schema": {
"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": "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"
}
}
}
}
}
},
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": {
"head": {
"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"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"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": {
"head": {
"tags": [
"mcp_projects"
],
"summary": "Streamable Health",
"operationId": "streamable_health_api_v1_mcp_project__project_id__streamable_head",
"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"
}
}
}
}
}
},
"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_delete",
"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_delete",
"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"
}
}
}
}
}
},
"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_delete",
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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/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": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "flow_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Flow Name"
}
}
],
"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"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/agentic/check-config": {
"get": {
"tags": [
"Agentic"
],
"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",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"type": "object",
"title": "Response Check Assistant Config Api V1 Agentic Check Config Get"
}
}
}
}
},
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
]
}
},
"/api/v1/agentic/assist": {
"post": {
"tags": [
"Agentic"
],
"summary": "Assist",
"description": "Chat with the Langflow Assistant.",
"operationId": "assist_api_v1_agentic_assist_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssistantRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"type": "object",
"title": "Response Assist Api V1 Agentic Assist Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
]
}
},
"/api/v1/agentic/assist/stream": {
"post": {
"tags": [
"Agentic"
],
"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"
}
}
},
"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/": {
"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"
}
}
],
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/langflow__services__database__models__file__model__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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"API key query": []
},
{
"API key header": []
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/langflow__services__database__models__file__model__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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"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",
"security": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": {
"$ref": "#/components/schemas/MCPServerConfig"
}
}
}
},
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": {
"$ref": "#/components/schemas/MCPServerConfig"
}
}
}
},
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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/workflows": {
"post": {
"tags": [
"Workflow"
],
"summary": "Execute Workflow",
"description": "Execute a workflow with support for sync, stream, and background modes",
"operationId": "execute_workflow_api_v2_workflows_post",
"security": [
{
"API key query": []
},
{
"API key header": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowExecutionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Workflow execution response",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$defs": {
"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": "#/$defs/JobStatus"
},
"content": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Content"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata"
}
},
"required": [
"type",
"status"
],
"title": "ComponentOutput",
"type": "object"
},
"ErrorDetail": {
"description": "Error detail schema.",
"properties": {
"error": {
"title": "Error",
"type": "string"
},
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code"
},
"details": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"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"
}
},
"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": "#/$defs/JobStatus"
},
"errors": {
"default": [],
"items": {
"$ref": "#/$defs/ErrorDetail"
},
"title": "Errors",
"type": "array"
},
"inputs": {
"additionalProperties": true,
"default": {},
"title": "Inputs",
"type": "object"
},
"outputs": {
"additionalProperties": {
"$ref": "#/$defs/ComponentOutput"
},
"default": {},
"title": "Outputs",
"type": "object"
}
},
"required": [
"flow_id",
"status"
],
"title": "WorkflowExecutionResponse",
"type": "object"
},
{
"$defs": {
"ErrorDetail": {
"description": "Error detail schema.",
"properties": {
"error": {
"title": "Error",
"type": "string"
},
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code"
},
"details": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"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"
}
},
"description": "Background job response.",
"properties": {
"job_id": {
"anyOf": [
{
"type": "string"
},
{
"format": "uuid",
"type": "string"
}
],
"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": "#/$defs/JobStatus"
},
"links": {
"additionalProperties": {
"type": "string"
},
"title": "Links",
"type": "object"
},
"errors": {
"default": [],
"items": {
"$ref": "#/$defs/ErrorDetail"
},
"title": "Errors",
"type": "array"
}
},
"required": [
"job_id",
"flow_id",
"status"
],
"title": "WorkflowJobResponse",
"type": "object"
}
],
"discriminator": {
"propertyName": "object",
"mapping": {
"response": "#/components/schemas/WorkflowExecutionResponse",
"job": "#/components/schemas/WorkflowJobResponse"
}
}
}
},
"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"
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Workflow"
],
"summary": "Get Workflow Status",
"description": "Get status of workflow job by job ID",
"operationId": "get_workflow_status_api_v2_workflows_get",
"security": [
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "job_id",
"in": "query",
"required": false,
"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": {
"$defs": {
"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": "#/$defs/JobStatus"
},
"content": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Content"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata"
}
},
"required": [
"type",
"status"
],
"title": "ComponentOutput",
"type": "object"
},
"ErrorDetail": {
"description": "Error detail schema.",
"properties": {
"error": {
"title": "Error",
"type": "string"
},
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code"
},
"details": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"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"
}
},
"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": "#/$defs/JobStatus"
},
"errors": {
"default": [],
"items": {
"$ref": "#/$defs/ErrorDetail"
},
"title": "Errors",
"type": "array"
},
"inputs": {
"additionalProperties": true,
"default": {},
"title": "Inputs",
"type": "object"
},
"outputs": {
"additionalProperties": {
"$ref": "#/$defs/ComponentOutput"
},
"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"
}
}
}
}
}
}
},
"/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"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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": [
{
"OAuth2PasswordBearerCookie": []
},
{
"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"
},
"AssistantRequest": {
"properties": {
"flow_id": {
"type": "string",
"title": "Flow Id"
},
"component_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Component Id"
},
"field_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Field Name"
},
"input_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Input Value"
},
"max_retries": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Retries"
},
"model_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model Name"
},
"provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider"
},
"session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Id"
}
},
"type": "object",
"required": [
"flow_id"
],
"title": "AssistantRequest",
"description": "Request model for assistant interactions."
},
"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_callback_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Oauth Callback Url"
},
"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."
},
"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_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_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_upload_file_api_v1_files_upload__flow_id__post": {
"properties": {
"file": {
"type": "string",
"contentMediaType": "application/octet-stream",
"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",
"contentMediaType": "application/octet-stream",
"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",
"contentMediaType": "application/octet-stream",
"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",
"contentMediaType": "application/octet-stream",
"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",
"contentMediaType": "application/octet-stream",
"title": "File"
}
},
"type": "object",
"required": [
"file"
],
"title": "Body_upload_user_file_api_v2_files_post"
},
"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."
},
"CodeContent": {
"additionalProperties": true,
"type": "object"
},
"ComposerUrlResponse": {
"properties": {
"project_id": {
"type": "string",
"title": "Project 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": {
"max_file_size_upload": {
"type": "integer",
"title": "Max File Size Upload"
},
"event_delivery": {
"type": "string",
"enum": [
"polling",
"streaming",
"direct"
],
"title": "Event Delivery"
},
"voice_mode_available": {
"type": "boolean",
"title": "Voice Mode Available"
},
"frontend_timeout": {
"type": "integer",
"title": "Frontend Timeout"
},
"type": {
"type": "string",
"const": "full",
"title": "Type",
"default": "full"
},
"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"
},
"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"
},
"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"
},
"webhook_auth_enable": {
"type": "boolean",
"title": "Webhook Auth Enable"
},
"default_folder_name": {
"type": "string",
"title": "Default Folder Name"
},
"hide_getting_started_progress": {
"type": "boolean",
"title": "Hide Getting Started Progress"
}
},
"type": "object",
"required": [
"max_file_size_upload",
"event_delivery",
"voice_mode_available",
"frontend_timeout",
"feature_flags",
"serialization_max_items_length",
"serialization_max_text_length",
"auto_saving",
"auto_saving_interval",
"health_check_max_retries",
"webhook_polling_interval",
"public_flow_cleanup_interval",
"public_flow_expiration",
"webhook_auth_enable",
"default_folder_name",
"hide_getting_started_progress"
],
"title": "ConfigResponse",
"description": "Full configuration response for authenticated users.\n\nThe 'type' field is a discriminator to distinguish from PublicConfigResponse."
},
"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."
},
"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"
},
"Flow": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Icon"
},
"icon_bg_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Icon Bg Color"
},
"gradient": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Gradient"
},
"data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Data"
},
"is_component": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Component",
"default": false
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated At"
},
"webhook": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Webhook",
"description": "Can be used on the webhook endpoint",
"default": false
},
"endpoint_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Endpoint Name"
},
"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"
},
{
"type": "null"
}
],
"title": "Action Name",
"description": "The name of the action associated with the flow"
},
"action_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"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"
},
"fs_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fs Path"
}
},
"type": "object",
"required": [
"name",
"user_id"
],
"title": "Flow"
},
"FlowCreate": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Icon"
},
"icon_bg_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Icon Bg Color"
},
"gradient": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Gradient"
},
"data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Data"
},
"is_component": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Component",
"default": false
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated At"
},
"webhook": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Webhook",
"description": "Can be used on the webhook endpoint",
"default": false
},
"endpoint_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"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": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Mcp Enabled",
"description": "Can be exposed in the MCP server",
"default": false
},
"action_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Action Name",
"description": "The name of the action associated with the flow"
},
"action_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Action Description",
"description": "The description of the action associated with the flow"
},
"access_type": {
"$ref": "#/components/schemas/AccessTypeEnum",
"default": "PRIVATE"
},
"user_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "User Id"
},
"folder_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Folder Id"
},
"fs_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fs Path"
}
},
"type": "object",
"required": [
"name"
],
"title": "FlowCreate"
},
"FlowDataRequest": {
"properties": {
"nodes": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Nodes"
},
"edges": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Edges"
},
"viewport": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Viewport"
}
},
"type": "object",
"required": [
"nodes",
"edges"
],
"title": "FlowDataRequest"
},
"FlowHeader": {
"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"
},
"folder_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Folder Id",
"description": "The ID of the folder containing the flow. None if not associated with a folder"
},
"is_component": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Component",
"description": "Flag indicating whether the flow is a component"
},
"endpoint_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Endpoint Name",
"description": "The name of the endpoint associated with this flow"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "A description of the flow"
},
"data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Data",
"description": "The data of the component, if is_component is True"
},
"access_type": {
"anyOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"type": "null"
}
],
"description": "The access type of the flow"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tags",
"description": "The tags of the flow"
},
"mcp_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Mcp Enabled",
"description": "Flag indicating whether the flow is exposed in the MCP server"
},
"action_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Action Name",
"description": "The name of the action associated with the flow"
},
"action_description": {
"anyOf": [
{
"type": "string"
},
{
"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."
},
"FlowListCreate": {
"properties": {
"flows": {
"items": {
"$ref": "#/components/schemas/FlowCreate"
},
"type": "array",
"title": "Flows"
}
},
"type": "object",
"required": [
"flows"
],
"title": "FlowListCreate"
},
"FlowRead": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Icon"
},
"icon_bg_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Icon Bg Color"
},
"gradient": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Gradient"
},
"data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Data"
},
"is_component": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Component",
"default": false
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated At"
},
"webhook": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Webhook",
"description": "Can be used on the webhook endpoint",
"default": false
},
"endpoint_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Endpoint Name"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tags",
"description": "The tags of the flow"
},
"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"
},
{
"type": "null"
}
],
"title": "Action Name",
"description": "The name of the action associated with the flow"
},
"action_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"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"
}
},
"type": "object",
"required": [
"name",
"id",
"user_id",
"folder_id"
],
"title": "FlowRead"
},
"FlowUpdate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Data"
},
"folder_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Folder Id"
},
"endpoint_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Endpoint Name"
},
"mcp_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Mcp Enabled"
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Locked"
},
"action_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Action Name"
},
"action_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Action Description"
},
"access_type": {
"anyOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"type": "null"
}
]
},
"fs_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fs Path"
}
},
"type": "object",
"title": "FlowUpdate"
},
"FolderCreate": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"auth_settings": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"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": [
"name"
],
"title": "FolderCreate"
},
"FolderRead": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"auth_settings": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Auth Settings",
"description": "Authentication settings for the folder/project"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"parent_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Parent Id"
}
},
"type": "object",
"required": [
"name",
"id",
"parent_id"
],
"title": "FolderRead"
},
"FolderReadWithFlows": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"auth_settings": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Auth Settings",
"description": "Authentication settings for the folder/project"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"parent_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Parent Id"
},
"flows": {
"items": {
"$ref": "#/components/schemas/FlowRead"
},
"type": "array",
"title": "Flows",
"default": []
}
},
"type": "object",
"required": [
"name",
"id",
"parent_id"
],
"title": "FolderReadWithFlows"
},
"FolderUpdate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"parent_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"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"
},
"auth_settings": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"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"
},
"viewport": {
"anyOf": [
{
"$ref": "#/components/schemas/ViewPort"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"nodes",
"edges"
],
"title": "GraphData"
},
"GraphDumpResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/GraphData"
},
"is_component": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Component"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"endpoint_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Endpoint Name"
}
},
"type": "object",
"required": [
"data"
],
"title": "GraphDumpResponse"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"HealthResponse": {
"properties": {
"status": {
"type": "string",
"title": "Status",
"default": "nok"
},
"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"
},
{
"type": "null"
}
],
"title": "Input Value"
},
"session": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session"
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"chat",
"text",
"any"
]
},
{
"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": "integer"
},
{
"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."
}
},
"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"
},
"MCPInstallRequest": {
"properties": {
"client": {
"type": "string",
"title": "Client"
},
"transport": {
"anyOf": [
{
"type": "string",
"enum": [
"sse",
"streamablehttp"
]
},
{
"type": "null"
}
],
"title": "Transport"
}
},
"type": "object",
"required": [
"client"
],
"title": "MCPInstallRequest"
},
"MCPProjectUpdateRequest": {
"properties": {
"settings": {
"items": {
"$ref": "#/components/schemas/MCPSettings"
},
"type": "array",
"title": "Settings"
},
"auth_settings": {
"anyOf": [
{
"$ref": "#/components/schemas/AuthSettings"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"settings"
],
"title": "MCPProjectUpdateRequest",
"description": "Request model for updating MCP project settings including auth."
},
"MCPServerConfig": {
"properties": {
"command": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Command"
},
"args": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Args"
},
"env": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Env"
},
"headers": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Headers"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
}
},
"additionalProperties": true,
"type": "object",
"title": "MCPServerConfig",
"description": "Pydantic model for MCP server configuration."
},
"MCPSettings": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"mcp_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Mcp Enabled"
},
"action_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Action Name"
},
"action_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Action Description"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
}
},
"type": "object",
"required": [
"id"
],
"title": "MCPSettings",
"description": "Model representing MCP settings for a flow."
},
"MediaContent": {
"additionalProperties": true,
"type": "object"
},
"MessageRead": {
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"sender": {
"type": "string",
"title": "Sender"
},
"sender_name": {
"type": "string",
"title": "Sender Name"
},
"session_id": {
"type": "string",
"title": "Session Id"
},
"context_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context Id"
},
"text": {
"type": "string",
"title": "Text"
},
"files": {
"items": {
"type": "string"
},
"type": "array",
"title": "Files"
},
"error": {
"type": "boolean",
"title": "Error",
"default": false
},
"edit": {
"type": "boolean",
"title": "Edit",
"default": false
},
"properties": {
"$ref": "#/components/schemas/Properties"
},
"category": {
"type": "string",
"title": "Category",
"default": "message"
},
"content_blocks": {
"items": {
"$ref": "#/components/schemas/ContentBlock"
},
"type": "array",
"title": "Content Blocks"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"flow_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Id"
}
},
"type": "object",
"required": [
"sender",
"sender_name",
"session_id",
"text",
"id",
"flow_id"
],
"title": "MessageRead"
},
"MessageResponse": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id"
},
"flow_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Id"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"sender": {
"type": "string",
"title": "Sender"
},
"sender_name": {
"type": "string",
"title": "Sender Name"
},
"session_id": {
"type": "string",
"title": "Session Id"
},
"context_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context Id"
},
"text": {
"type": "string",
"title": "Text"
},
"files": {
"items": {
"type": "string"
},
"type": "array",
"title": "Files",
"default": []
},
"edit": {
"type": "boolean",
"title": "Edit"
},
"duration": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Duration"
},
"properties": {
"anyOf": [
{
"$ref": "#/components/schemas/Properties"
},
{
"type": "null"
}
]
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Category"
},
"content_blocks": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ContentBlock"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Content Blocks"
}
},
"type": "object",
"required": [
"sender",
"sender_name",
"session_id",
"text",
"edit"
],
"title": "MessageResponse"
},
"MessageUpdate": {
"properties": {
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text"
},
"sender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sender"
},
"sender_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sender Name"
},
"session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Id"
},
"context_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context Id"
},
"files": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Files"
},
"edit": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Edit"
},
"error": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Error"
},
"properties": {
"anyOf": [
{
"$ref": "#/components/schemas/Properties"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "MessageUpdate"
},
"OpenAIResponsesRequest": {
"properties": {
"model": {
"type": "string",
"title": "Model",
"description": "The flow ID to execute (used instead of OpenAI model)"
},
"input": {
"type": "string",
"title": "Input",
"description": "The input text to process"
},
"stream": {
"type": "boolean",
"title": "Stream",
"description": "Whether to stream the response",
"default": false
},
"background": {
"type": "boolean",
"title": "Background",
"description": "Whether to process in background",
"default": false
},
"tools": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tools",
"description": "Tools are not supported yet"
},
"previous_response_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous Response Id",
"description": "ID of previous response to continue conversation"
},
"include": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Include",
"description": "Additional response data to include, e.g., ['tool_call.results']"
}
},
"type": "object",
"required": [
"model",
"input"
],
"title": "OpenAIResponsesRequest",
"description": "OpenAI-compatible responses request with flow_id as model parameter."
},
"Page_FlowRead_": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/FlowRead"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total"
},
"page": {
"type": "integer",
"minimum": 1.0,
"title": "Page"
},
"size": {
"type": "integer",
"minimum": 1.0,
"title": "Size"
},
"pages": {
"type": "integer",
"minimum": 0.0,
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[FlowRead]"
},
"Page_Flow_": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Flow"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total"
},
"page": {
"type": "integer",
"minimum": 1.0,
"title": "Page"
},
"size": {
"type": "integer",
"minimum": 1.0,
"title": "Size"
},
"pages": {
"type": "integer",
"minimum": 0.0,
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[Flow]"
},
"Page_TransactionLogsResponse_": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TransactionLogsResponse"
},
"type": "array",
"title": "Items"
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total"
},
"page": {
"type": "integer",
"minimum": 1.0,
"title": "Page"
},
"size": {
"type": "integer",
"minimum": 1.0,
"title": "Size"
},
"pages": {
"type": "integer",
"minimum": 0.0,
"title": "Pages"
}
},
"type": "object",
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[TransactionLogsResponse]"
},
"Properties": {
"properties": {
"text_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Color"
},
"background_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Background Color"
},
"edited": {
"type": "boolean",
"title": "Edited",
"default": false
},
"source": {
"$ref": "#/components/schemas/Source"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Icon"
},
"allow_markdown": {
"type": "boolean",
"title": "Allow Markdown",
"default": false
},
"positive_feedback": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Positive Feedback"
},
"state": {
"type": "string",
"enum": [
"partial",
"complete"
],
"title": "State",
"default": "complete"
},
"targets": {
"items": {},
"type": "array",
"title": "Targets",
"default": []
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"type": "null"
}
]
},
"build_duration": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Build Duration"
}
},
"type": "object",
"title": "Properties"
},
"PublicConfigResponse": {
"properties": {
"max_file_size_upload": {
"type": "integer",
"title": "Max File Size Upload"
},
"event_delivery": {
"type": "string",
"enum": [
"polling",
"streaming",
"direct"
],
"title": "Event Delivery"
},
"voice_mode_available": {
"type": "boolean",
"title": "Voice Mode Available"
},
"frontend_timeout": {
"type": "integer",
"title": "Frontend Timeout"
},
"type": {
"type": "string",
"const": "public",
"title": "Type",
"default": "public"
}
},
"type": "object",
"required": [
"max_file_size_upload",
"event_delivery",
"voice_mode_available",
"frontend_timeout"
],
"title": "PublicConfigResponse",
"description": "Configuration response for public/unauthenticated endpoints like the public playground.\n\nContains only the configuration values needed for public features, without sensitive data.\nThe 'type' field is a discriminator to distinguish from full ConfigResponse."
},
"ResultData": {
"properties": {
"results": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Results"
},
"artifacts": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Artifacts"
},
"outputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Outputs"
},
"logs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Logs"
},
"messages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ChatOutputResponse"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Messages"
},
"timedelta": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Timedelta"
},
"duration": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Duration"
},
"component_display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Component Display Name"
},
"component_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Component Id"
},
"used_frozen_result": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Used Frozen Result",
"default": false
}
},
"type": "object",
"title": "ResultData"
},
"RunOutputs": {
"properties": {
"inputs": {
"additionalProperties": true,
"type": "object",
"title": "Inputs"
},
"outputs": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ResultData"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Outputs"
}
},
"type": "object",
"title": "RunOutputs"
},
"RunResponse": {
"properties": {
"outputs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RunOutputs"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Outputs",
"default": []
},
"session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Id"
}
},
"type": "object",
"title": "RunResponse",
"description": "Run response schema."
},
"SimplifiedAPIRequest": {
"properties": {
"input_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Input Value",
"description": "The input value"
},
"input_type": {
"anyOf": [
{
"type": "string",
"enum": [
"chat",
"text",
"any"
]
},
{
"type": "null"
}
],
"title": "Input Type",
"description": "The input type",
"default": "chat"
},
"output_type": {
"anyOf": [
{
"type": "string",
"enum": [
"chat",
"text",
"any",
"debug"
]
},
{
"type": "null"
}
],
"title": "Output Type",
"description": "The output type",
"default": "chat"
},
"output_component": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Output Component",
"description": "If there are multiple output components, you can specify the component to get the output from.",
"default": ""
},
"tweaks": {
"anyOf": [
{
"$ref": "#/components/schemas/Tweaks"
},
{
"type": "null"
}
],
"description": "The tweaks"
},
"session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Id",
"description": "The session id"
}
},
"type": "object",
"title": "SimplifiedAPIRequest"
},
"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"
},
"SpanReadResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"type": {
"$ref": "#/components/schemas/SpanType"
},
"status": {
"$ref": "#/components/schemas/SpanStatus"
},
"startTime": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Starttime"
},
"endTime": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Endtime"
},
"latencyMs": {
"type": "integer",
"title": "Latencyms"
},
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Inputs"
},
"outputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Outputs"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
},
"modelName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Modelname"
},
"tokenUsage": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Tokenusage"
},
"children": {
"items": {
"$ref": "#/components/schemas/SpanReadResponse"
},
"type": "array",
"title": "Children"
}
},
"type": "object",
"required": [
"id",
"name",
"type",
"status",
"startTime",
"endTime",
"latencyMs",
"inputs",
"outputs",
"error",
"modelName",
"tokenUsage"
],
"title": "SpanReadResponse",
"description": "Response model for a single span, with nested children.\n\nSerializes to camelCase JSON to match the frontend API contract."
},
"SpanStatus": {
"type": "string",
"enum": [
"unset",
"ok",
"error"
],
"title": "SpanStatus",
"description": "OpenTelemetry status codes.\n\n- UNSET: Default status, span has not ended yet\n- OK: Span completed successfully\n- ERROR: Span completed with an error"
},
"SpanType": {
"type": "string",
"enum": [
"chain",
"llm",
"tool",
"retriever",
"embedding",
"parser",
"agent"
],
"title": "SpanType",
"description": "Types of spans that can be recorded."
},
"TextContent": {
"additionalProperties": true,
"type": "object"
},
"ToolContent": {
"additionalProperties": true,
"type": "object"
},
"TraceListResponse": {
"properties": {
"traces": {
"items": {
"$ref": "#/components/schemas/TraceSummaryRead"
},
"type": "array",
"title": "Traces"
},
"total": {
"type": "integer",
"title": "Total"
},
"pages": {
"type": "integer",
"title": "Pages"
}
},
"type": "object",
"required": [
"traces",
"total",
"pages"
],
"title": "TraceListResponse",
"description": "Paginated list response for traces."
},
"TraceRead": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"status": {
"$ref": "#/components/schemas/SpanStatus"
},
"startTime": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Starttime"
},
"endTime": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Endtime"
},
"totalLatencyMs": {
"type": "integer",
"title": "Totallatencyms"
},
"totalTokens": {
"type": "integer",
"title": "Totaltokens"
},
"flowId": {
"type": "string",
"format": "uuid",
"title": "Flowid"
},
"sessionId": {
"type": "string",
"title": "Sessionid"
},
"input": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Input"
},
"output": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Output"
},
"spans": {
"items": {
"$ref": "#/components/schemas/SpanReadResponse"
},
"type": "array",
"title": "Spans"
}
},
"type": "object",
"required": [
"id",
"name",
"status",
"startTime",
"endTime",
"totalLatencyMs",
"totalTokens",
"flowId",
"sessionId"
],
"title": "TraceRead",
"description": "Response model for a single trace with its hierarchical span tree.\n\nSerializes to camelCase JSON to match the frontend API contract."
},
"TraceSummaryRead": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"status": {
"$ref": "#/components/schemas/SpanStatus"
},
"startTime": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Starttime"
},
"totalLatencyMs": {
"type": "integer",
"title": "Totallatencyms"
},
"totalTokens": {
"type": "integer",
"title": "Totaltokens"
},
"flowId": {
"type": "string",
"format": "uuid",
"title": "Flowid"
},
"sessionId": {
"type": "string",
"title": "Sessionid"
},
"input": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Input"
},
"output": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Output"
}
},
"type": "object",
"required": [
"id",
"name",
"status",
"startTime",
"totalLatencyMs",
"totalTokens",
"flowId",
"sessionId"
],
"title": "TraceSummaryRead",
"description": "Lightweight trace model for list endpoint.\n\nSerializes to camelCase JSON to match the frontend API contract."
},
"TransactionLogsResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"vertex_id": {
"type": "string",
"title": "Vertex Id"
},
"target_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Id"
},
"inputs": {
"additionalProperties": true,
"type": "object",
"title": "Inputs"
},
"outputs": {
"additionalProperties": true,
"type": "object",
"title": "Outputs"
},
"status": {
"type": "string",
"title": "Status"
}
},
"type": "object",
"required": [
"id",
"vertex_id",
"status"
],
"title": "TransactionLogsResponse",
"description": "Transaction response model for logs view - excludes error and flow_id fields."
},
"Tweaks": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": true,
"type": "object"
}
]
},
"type": "object",
"title": "Tweaks",
"description": "A dictionary of tweaks to adjust the flow's execution. Allows customizing flow behavior dynamically. All tweaks are overridden by the input values.",
"examples": [
{
"Component Name": {
"parameter_name": "value"
},
"component_id": {
"parameter_name": "value"
},
"parameter_name": "value"
}
]
},
"Usage": {
"properties": {
"input_tokens": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Input Tokens"
},
"output_tokens": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Output Tokens"
},
"total_tokens": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total Tokens"
}
},
"type": "object",
"title": "Usage",
"description": "Token usage information from LLM responses."
},
"UserCreate": {
"properties": {
"username": {
"type": "string",
"title": "Username"
},
"password": {
"type": "string",
"title": "Password"
},
"optins": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Optins",
"default": {
"github_starred": false,
"dialog_dismissed": false,
"discord_clicked": false
}
}
},
"type": "object",
"required": [
"username",
"password"
],
"title": "UserCreate"
},
"UserRead": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"username": {
"type": "string",
"title": "Username"
},
"profile_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Profile Image"
},
"store_api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Store Api Key"
},
"is_active": {
"type": "boolean",
"title": "Is Active"
},
"is_superuser": {
"type": "boolean",
"title": "Is Superuser"
},
"create_at": {
"type": "string",
"format": "date-time",
"title": "Create At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"last_login_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Login At"
},
"optins": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Optins"
}
},
"type": "object",
"required": [
"username",
"profile_image",
"store_api_key",
"is_active",
"is_superuser",
"create_at",
"updated_at",
"last_login_at"
],
"title": "UserRead"
},
"UserUpdate": {
"properties": {
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Username"
},
"profile_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Profile Image"
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Password"
},
"is_active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
},
"is_superuser": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Superuser"
},
"last_login_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Login At"
},
"optins": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Optins"
}
},
"type": "object",
"title": "UserUpdate"
},
"UsersResponse": {
"properties": {
"total_count": {
"type": "integer",
"title": "Total Count"
},
"users": {
"items": {
"$ref": "#/components/schemas/UserRead"
},
"type": "array",
"title": "Users"
}
},
"type": "object",
"required": [
"total_count",
"users"
],
"title": "UsersResponse"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"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": {
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"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"
},
"job_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Job Id"
},
"build_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"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"
}
},
"type": "object",
"required": [
"x",
"y",
"zoom"
],
"title": "ViewPort"
},
"WorkflowExecutionRequest": {
"properties": {
"background": {
"type": "boolean",
"title": "Background",
"default": false
},
"stream": {
"type": "boolean",
"title": "Stream",
"default": false
},
"flow_id": {
"type": "string",
"title": "Flow Id"
},
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"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
},
{
"background": false,
"flow_id": "flow_67ccd2be17f0819081ff3bb2cf6508e60bb6a6b452d3795b",
"inputs": {
"ChatInput-abc.input_value": "Stream this conversation"
},
"stream": true
}
]
},
"WorkflowStopRequest": {
"properties": {
"job_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "uuid"
}
],
"title": "Job Id"
}
},
"type": "object",
"required": [
"job_id"
],
"title": "WorkflowStopRequest",
"description": "Request schema for stopping workflow."
},
"WorkflowStopResponse": {
"properties": {
"job_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "uuid"
}
],
"title": "Job Id"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
}
},
"type": "object",
"required": [
"job_id"
],
"title": "WorkflowStopResponse",
"description": "Response schema for stopping workflow."
},
"langflow__api__schemas__UploadFileResponse": {
"properties": {
"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"
},
{
"type": "null"
}
],
"title": "Provider"
}
},
"type": "object",
"required": [
"id",
"name",
"path",
"size"
],
"title": "UploadFileResponse",
"description": "File upload response schema."
},
"langflow__api__v1__schemas__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": "Upload file response schema."
},
"langflow__services__database__models__file__model__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": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"user_id",
"name",
"path",
"size"
],
"title": "File"
},
"lfx__utils__schemas__File": {
"properties": {
"path": {
"type": "string",
"title": "Path"
},
"name": {
"type": "string",
"title": "Name"
},
"type": {
"type": "string",
"title": "Type"
}
},
"type": "object",
"required": [
"path",
"name",
"type"
],
"title": "File",
"description": "File schema."
}
},
"securitySchemes": {
"OAuth2PasswordBearerCookie": {
"type": "oauth2",
"flows": {
"password": {
"scopes": {},
"tokenUrl": "api/v1/login"
}
}
},
"API key query": {
"type": "apiKey",
"in": "query",
"name": "x-api-key"
},
"API key header": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
}
}