docs: OpenAPI spec version upgraded from 1.2.0 to 1.3.2 (#7492)

* docs: OpenAPI spec version upgraded from 1.2.0 to 1.3.2

* remove-var-braces-in-descriptions

---------

Co-authored-by: github-merge-queue <118344674+github-merge-queue@users.noreply.github.com>
Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
This commit is contained in:
github-actions[bot] 2025-04-14 10:16:45 -04:00 • committed by GitHub
commit 90128ca4e3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,7 +2,7 @@
"openapi": "3.1.0", "openapi": "3.1.0",
"info": { "info": {
"title": "Langflow", "title": "Langflow",
"version": "1.2.0" "version": "1.3.2"
}, },
"paths": { "paths": {
"/api/v1/build/{flow_id}/vertices": { "/api/v1/build/{flow_id}/vertices": {
@ -104,7 +104,7 @@
"Chat" "Chat"
], ],
"summary": "Build Flow", "summary": "Build Flow",
"description": "Build and process a flow, returning a job ID for event polling.", "description": "Build and process a flow, returning a job ID for event polling.\n\nThis endpoint requires authentication through the CurrentActiveUser dependency.\nFor public flows that don't require authentication, use the /build_public_tmp/flow_id/flow endpoint.\n\nArgs:\n flow_id: UUID of the flow to build\n background_tasks: Background tasks manager\n inputs: Optional input values for the flow\n data: Optional flow data\n files: Optional files to include\n stop_component_id: Optional ID of component to stop at\n start_component_id: Optional ID of component to start from\n log_builds: Whether to log the build process\n current_user: The authenticated user\n queue_service: Queue service for job management\n flow_name: Optional name for the flow\n settings_service: Settings service\n\nReturns:\n Dict with job_id that can be used to poll for build status",
"operationId": "build_flow_api_v1_build__flow_id__flow_post", "operationId": "build_flow_api_v1_build__flow_id__flow_post",
"security": [ "security": [
{ {
@ -169,6 +169,22 @@
"default": true, "default": true,
"title": "Log Builds" "title": "Log Builds"
} }
},
{
"name": "flow_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Flow Name"
}
} }
], ],
"requestBody": { "requestBody": {
@ -417,12 +433,129 @@
} }
} }
}, },
"/api/v1/build_public_tmp/{flow_id}/flow": {
"post": {
"tags": [
"Chat"
],
"summary": "Build Public Tmp",
"description": "Build a public flow without requiring authentication.\n\nThis endpoint is specifically for public flows that don't require authentication.\nIt uses a client_id cookie to create a deterministic flow ID for tracking purposes.\n\nThe endpoint:\n1. Verifies the requested flow is marked as public in the database\n2. Creates a deterministic UUID based on client_id and flow_id\n3. Uses the flow owner's permissions to build the flow\n\nRequirements:\n- The flow must be marked as PUBLIC in the database\n- The request must include a client_id cookie\n\nArgs:\n flow_id: UUID of the public flow to build\n background_tasks: Background tasks manager\n inputs: Optional input values for the flow\n data: Optional flow data\n files: Optional files to include\n stop_component_id: Optional ID of component to stop at\n start_component_id: Optional ID of component to start from\n log_builds: Whether to log the build process\n flow_name: Optional name for the flow\n request: FastAPI request object (needed for cookie access)\n queue_service: Queue service for job management\n\nReturns:\n 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"
}
}
],
"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": { "/api/v1/all": {
"get": { "get": {
"tags": [ "tags": [
"Base" "Base"
], ],
"summary": "Get All", "summary": "Get All",
"description": "Retrieve all component types with compression for better performance.\n\nReturns a compressed response containing all available component types.",
"operationId": "get_all_api_v1_all_get", "operationId": "get_all_api_v1_all_get",
"responses": { "responses": {
"200": { "200": {
@ -613,7 +746,7 @@
"Base" "Base"
], ],
"summary": "Experimental Run Flow", "summary": "Experimental Run Flow",
"description": "Executes a specified flow by ID with optional input values, output selection, tweaks, and streaming capability.\n\nThis endpoint supports running flows with caching to enhance performance and efficiency.\n\n### Parameters:\n- `flow_id` (str): The unique identifier of the flow to be executed.\n- `inputs` (List[InputValueRequest], optional): A list of inputs specifying the input values and components\n for the flow. Each input can target specific components and provide custom values.\n- `outputs` (List[str], optional): A list of output names to retrieve from the executed flow.\n If not provided, all outputs are returned.\n- `tweaks` (Optional[Tweaks], optional): A dictionary of tweaks to customize the flow execution.\n The tweaks can be used to modify the flow's parameters and components.\n Tweaks can be overridden by the input values.\n- `stream` (bool, optional): Specifies whether the results should be streamed. Defaults to False.\n- `session_id` (Union[None, str], optional): An optional session ID to utilize existing session data for the flow\n execution.\n- `api_key_user` (User): The user associated with the current API key. Automatically resolved from the API key.\n\n### Returns:\nA `RunResponse` object containing the selected outputs (or all if not specified) of the executed flow\nand the session ID.\nThe structure of the response accommodates multiple inputs, providing a nested list of outputs for each input.\n\n### Raises:\nHTTPException: Indicates issues with finding the specified flow, invalid input formats, or internal errors during\nflow execution.\n\n### Example usage:\n```json\nPOST /run/{flow_id}\nx-api-key: YOUR_API_KEY\nPayload:\n{\n \"inputs\": [\n {\"components\": [\"component1\"], \"input_value\": \"value1\"},\n {\"components\": [\"component3\"], \"input_value\": \"value2\"}\n ],\n \"outputs\": [\"Component Name\", \"component_id\"],\n \"tweaks\": {\"parameter_name\": \"value\", \"Component Name\": {\"parameter_name\": \"value\"}, \"component_id\": {\"parameter_name\": \"value\"}}\n \"stream\": false\n}\n```\n\nThis endpoint facilitates complex flow executions with customized inputs, outputs, and configurations,\ncatering to diverse application requirements.", "description": "Executes a specified flow by ID with optional input values, output selection, tweaks, and streaming capability.\n\nThis endpoint supports running flows with caching to enhance performance and efficiency.\n\n### Parameters:\n- `flow_id` (str): The unique identifier of the flow to be executed.\n- `inputs` (List[InputValueRequest], optional): A list of inputs specifying the input values and components\n for the flow. Each input can target specific components and provide custom values.\n- `outputs` (List[str], optional): A list of output names to retrieve from the executed flow.\n If not provided, all outputs are returned.\n- `tweaks` (Optional[Tweaks], optional): A dictionary of tweaks to customize the flow execution.\n The tweaks can be used to modify the flow's parameters and components.\n Tweaks can be overridden by the input values.\n- `stream` (bool, optional): Specifies whether the results should be streamed. Defaults to False.\n- `session_id` (Union[None, str], optional): An optional session ID to utilize existing session data for the flow\n execution.\n- `api_key_user` (User): The user associated with the current API key. Automatically resolved from the API key.\n\n### Returns:\nA `RunResponse` object containing the selected outputs (or all if not specified) of the executed flow\nand the session ID.\nThe structure of the response accommodates multiple inputs, providing a nested list of outputs for each input.\n\n### Raises:\nHTTPException: Indicates issues with finding the specified flow, invalid input formats, or internal errors during\nflow execution.\n\n### Example usage:\n```json\nPOST /run/flow_id\nx-api-key: YOUR_API_KEY\nPayload:\n{\n \"inputs\": [\n {\"components\": [\"component1\"], \"input_value\": \"value1\"},\n {\"components\": [\"component3\"], \"input_value\": \"value2\"}\n ],\n \"outputs\": [\"Component Name\", \"component_id\"],\n \"tweaks\": {\"parameter_name\": \"value\", \"Component Name\": {\"parameter_name\": \"value\"}, \"component_id\": {\"parameter_name\": \"value\"}}\n \"stream\": false\n}\n```\n\nThis endpoint facilitates complex flow executions with customized inputs, outputs, and configurations,\ncatering to diverse application requirements.",
"operationId": "experimental_run_flow_api_v1_run_advanced__flow_id__post", "operationId": "experimental_run_flow_api_v1_run_advanced__flow_id__post",
"security": [ "security": [
{ {
@ -668,14 +801,32 @@
} }
} }
}, },
"/api/v1/process/{flow_id}": { "/api/v1/process/{_flow_id}": {
"post": { "post": {
"tags": [ "tags": [
"Base" "Base"
], ],
"summary": "Process", "summary": "Process",
"description": "Endpoint to process an input with a given flow_id.", "description": "Endpoint to process an input with a given flow_id.",
"operationId": "process_api_v1_process__flow_id__post", "operationId": "process_api_v1_process___flow_id__post",
"security": [
{
"API key query": []
},
{
"API key header": []
}
],
"parameters": [
{
"name": "_flow_id",
"in": "path",
"required": true,
"schema": {
"title": " Flow Id"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful Response", "description": "Successful Response",
@ -687,8 +838,28 @@
} }
} }
} }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
} }
}, },
"/api/v1/predict/{_flow_id}": {
"post": {
"tags": [
"Base"
],
"summary": "Process",
"description": "Endpoint to process an input with a given flow_id.",
"operationId": "process_api_v1_predict___flow_id__post",
"security": [ "security": [
{ {
"API key query": [] "API key query": []
@ -696,17 +867,17 @@
{ {
"API key header": [] "API key header": []
} }
]
}
},
"/api/v1/predict/{flow_id}": {
"post": {
"tags": [
"Base"
], ],
"summary": "Process", "parameters": [
"description": "Endpoint to process an input with a given flow_id.", {
"operationId": "process_api_v1_predict__flow_id__post", "name": "_flow_id",
"in": "path",
"required": true,
"schema": {
"title": " Flow Id"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful Response", "description": "Successful Response",
@ -718,16 +889,18 @@
} }
} }
} }
}
}, },
"security": [ "422": {
{ "description": "Validation Error",
"API key query": [] "content": {
}, "application/json": {
{ "schema": {
"API key header": [] "$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
} }
]
} }
}, },
"/api/v1/task/{_task_id}": { "/api/v1/task/{_task_id}": {
@ -1010,7 +1183,18 @@
} }
} }
} }
},
"security": [
{
"OAuth2PasswordBearer": []
},
{
"API key query": []
},
{
"API key header": []
} }
]
} }
}, },
"/api/v1/validate/prompt": { "/api/v1/validate/prompt": {
@ -2004,6 +2188,50 @@
} }
} }
}, },
"/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/": { "/api/v1/flows/batch/": {
"post": { "post": {
"tags": [ "tags": [
@ -4312,6 +4540,37 @@
] ]
} }
}, },
"/api/v1/voice/elevenlabs/voice_ids": {
"get": {
"tags": [
"Voice"
],
"summary": "Get Elevenlabs Voice Ids",
"description": "Get available voice IDs from ElevenLabs API.",
"operationId": "get_elevenlabs_voice_ids_api_v1_voice_elevenlabs_voice_ids_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"OAuth2PasswordBearer": []
},
{
"API key query": []
},
{
"API key header": []
}
]
}
},
"/api/v1/mcp/sse": { "/api/v1/mcp/sse": {
"get": { "get": {
"tags": [ "tags": [
@ -4639,6 +4898,50 @@
} }
} }
}, },
"/api/mcp/sse": {
"get": {
"tags": [
"mcp"
],
"summary": "Handle Sse",
"operationId": "handle_sse_api_mcp_sse_get",
"responses": {
"200": {
"description": "Successful Response"
}
},
"security": [
{
"OAuth2PasswordBearer": []
},
{
"API key query": []
},
{
"API key header": []
}
]
}
},
"/api/mcp/": {
"post": {
"tags": [
"mcp"
],
"summary": "Handle Messages",
"operationId": "handle_messages_api_mcp__post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/health": { "/health": {
"get": { "get": {
"tags": [ "tags": [
@ -4769,6 +5072,14 @@
}, },
"components": { "components": {
"schemas": { "schemas": {
"AccessTypeEnum": {
"type": "string",
"enum": [
"PRIVATE",
"PUBLIC"
],
"title": "AccessTypeEnum"
},
"ApiKeyCreate": { "ApiKeyCreate": {
"properties": { "properties": {
"name": { "name": {
@ -4992,6 +5303,46 @@
"type": "object", "type": "object",
"title": "Body_build_flow_api_v1_build__flow_id__flow_post" "title": "Body_build_flow_api_v1_build__flow_id__flow_post"
}, },
"Body_build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post": {
"properties": {
"inputs": {
"anyOf": [
{
"$ref": "#/components/schemas/InputValueRequest"
},
{
"type": "null"
}
]
},
"data": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowDataRequest"
},
{
"type": "null"
}
]
},
"files": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Files"
}
},
"type": "object",
"title": "Body_build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post"
},
"Body_build_vertex_api_v1_build__flow_id__vertices__vertex_id__post": { "Body_build_vertex_api_v1_build__flow_id__vertices__vertex_id__post": {
"properties": { "properties": {
"inputs": { "inputs": {
@ -5368,6 +5719,16 @@
"feature_flags": { "feature_flags": {
"$ref": "#/components/schemas/FeatureFlags" "$ref": "#/components/schemas/FeatureFlags"
}, },
"serialization_max_items_lenght": {
"type": "integer",
"title": "Serialization Max Items Lenght",
"default": 1000
},
"serialization_max_text_length": {
"type": "integer",
"title": "Serialization Max Text Length",
"default": 20000
},
"frontend_timeout": { "frontend_timeout": {
"type": "integer", "type": "integer",
"title": "Frontend Timeout" "title": "Frontend Timeout"
@ -5388,11 +5749,24 @@
"type": "integer", "type": "integer",
"title": "Max File Size Upload" "title": "Max File Size Upload"
}, },
"webhook_polling_interval": {
"type": "integer",
"title": "Webhook Polling Interval"
},
"public_flow_cleanup_interval": {
"type": "integer",
"title": "Public Flow Cleanup Interval"
},
"public_flow_expiration": {
"type": "integer",
"title": "Public Flow Expiration"
},
"event_delivery": { "event_delivery": {
"type": "string", "type": "string",
"enum": [ "enum": [
"polling", "polling",
"streaming" "streaming",
"direct"
], ],
"title": "Event Delivery" "title": "Event Delivery"
} }
@ -5405,6 +5779,9 @@
"auto_saving_interval", "auto_saving_interval",
"health_check_max_retries", "health_check_max_retries",
"max_file_size_upload", "max_file_size_upload",
"webhook_polling_interval",
"public_flow_cleanup_interval",
"public_flow_expiration",
"event_delivery" "event_delivery"
], ],
"title": "ConfigResponse" "title": "ConfigResponse"
@ -5782,6 +6159,10 @@
"title": "Locked", "title": "Locked",
"default": false "default": false
}, },
"access_type": {
"$ref": "#/components/schemas/AccessTypeEnum",
"default": "PRIVATE"
},
"id": { "id": {
"type": "string", "type": "string",
"format": "uuid", "format": "uuid",
@ -5810,6 +6191,17 @@
} }
], ],
"title": "Folder Id" "title": "Folder Id"
},
"fs_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fs Path"
} }
}, },
"type": "object", "type": "object",
@ -5954,6 +6346,10 @@
"title": "Locked", "title": "Locked",
"default": false "default": false
}, },
"access_type": {
"$ref": "#/components/schemas/AccessTypeEnum",
"default": "PRIVATE"
},
"user_id": { "user_id": {
"anyOf": [ "anyOf": [
{ {
@ -5977,6 +6373,17 @@
} }
], ],
"title": "Folder Id" "title": "Folder Id"
},
"fs_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fs Path"
} }
}, },
"type": "object", "type": "object",
@ -6093,6 +6500,32 @@
], ],
"title": "Data", "title": "Data",
"description": "The data of the component, if is_component is True" "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"
} }
}, },
"type": "object", "type": "object",
@ -6240,7 +6673,8 @@
"type": "null" "type": "null"
} }
], ],
"title": "Tags" "title": "Tags",
"description": "The tags of the flow"
}, },
"locked": { "locked": {
"anyOf": [ "anyOf": [
@ -6254,6 +6688,10 @@
"title": "Locked", "title": "Locked",
"default": false "default": false
}, },
"access_type": {
"$ref": "#/components/schemas/AccessTypeEnum",
"default": "PRIVATE"
},
"id": { "id": {
"type": "string", "type": "string",
"format": "uuid", "format": "uuid",
@ -6361,6 +6799,27 @@
} }
], ],
"title": "Locked" "title": "Locked"
},
"access_type": {
"anyOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"type": "null"
}
]
},
"fs_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fs Path"
} }
}, },
"type": "object", "type": "object",
@ -6671,6 +7130,17 @@
"title": "Display Name", "title": "Display Name",
"default": "" "default": ""
}, },
"priority": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Priority"
},
"documentation": { "documentation": {
"type": "string", "type": "string",
"title": "Documentation", "title": "Documentation",
@ -6866,6 +7336,17 @@
"type": "string", "type": "string",
"title": "Display Name" "title": "Display Name"
}, },
"priority": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Priority"
},
"documentation": { "documentation": {
"type": "string", "type": "string",
"title": "Documentation", "title": "Documentation",
@ -7876,6 +8357,16 @@
"title": "Allows Loop", "title": "Allows Loop",
"default": false "default": false
}, },
"options": {
"anyOf": [
{
"$ref": "#/components/schemas/OutputOptions"
},
{
"type": "null"
}
]
},
"tool_mode": { "tool_mode": {
"type": "boolean", "type": "boolean",
"title": "Tool Mode", "title": "Tool Mode",
@ -7888,6 +8379,23 @@
], ],
"title": "Output" "title": "Output"
}, },
"OutputOptions": {
"properties": {
"filter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filter"
}
},
"type": "object",
"title": "OutputOptions"
},
"OutputValue": { "OutputValue": {
"properties": { "properties": {
"message": { "message": {