Langflow | Langflow Documentation
Langflow (1.7.3)
Download OpenAPI specification:Download
Retrieve Vertices Order Deprecated
Retrieve the vertices order for a given flow.
Args:
flow_id (str): The ID of the flow.
background_tasks (BackgroundTasks): The background tasks.
data (Optional[FlowDataRequest], optional): The flow data. Defaults to None.
stop_component_id (str, optional): The ID of the stop component. Defaults to None.
start_component_id (str, optional): The ID of the start component. Defaults to None.
session (AsyncSession, optional): The session dependency.
Returns:
VerticesOrderResponse: The response containing the ordered vertex IDs and the run ID.
Raises:
HTTPException: If there is an error checking the build status.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| flow_id required |
query Parameters
Stop Component Id (string) or Stop Component Id (null) (Stop Component Id) | |
Start Component Id (string) or Start Component Id (null) (Start Component Id) |
Request Body schema: application/json
Any of
required | |
required | |
Viewport (object) or Viewport (null) (Viewport) |
Responses
Request samples
- Payload
Content type
application/json
{
"nodes": [{ }
],"edges": [{ }
],"viewport": { }
}Response samples
- 200
- 422
Content type
application/json
{
"ids": ["string"
],"run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec","vertices_to_run": ["string"
]
}Build Flow
Build and process a flow, returning a job ID for event polling.
This endpoint requires authentication through the CurrentActiveUser dependency.
For public flows that don't require authentication, use the /build_public_tmp/flow_id/flow endpoint.
Args:
flow_id: UUID of the flow to build
background_tasks: Background tasks manager
inputs: Optional input values for the flow
data: Optional flow data
files: Optional files to include
stop_component_id: Optional ID of component to stop at
start_component_id: Optional ID of component to start from
log_builds: Whether to log the build process
current_user: The authenticated user
queue_service: Queue service for job management
flow_name: Optional name for the flow
event_delivery: Optional event delivery type - default is streaming
Returns:
Dict with job_id that can be used to poll for build status
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| flow_id required |
query Parameters
Stop Component Id (string) or Stop Component Id (null) (Stop Component Id) | |
Start Component Id (string) or Start Component Id (null) (Start Component Id) | |
| log_builds | boolean (Log Builds) Default: true |
Flow Name (string) or Flow Name (null) (Flow Name) | |
| event_delivery | string (EventDeliveryType) Default: "polling" Enum: "streaming" "direct" "polling" |
Request Body schema: application/json
InputValueRequest (object) or null | |
FlowDataRequest (object) or null | |
Array of Files (strings) or Files (null) (Files) |
Responses
Request samples
- Payload
Content type
application/json
{
"inputs": {"components": ["components_id","Component Name"
],"input_value": "input_value","session": "session_id"
},"data": {"viewport": { }
},"files": ["string"
]
}Response samples
- 200
- 422
Content type
application/json
Get Build Events
Get events for a specific build job.
Requires authentication to prevent unauthorized access to build events.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| job_id required |
query Parameters
| event_delivery | string (EventDeliveryType) Default: "streaming" Enum: "streaming" "direct" "polling" |
Responses
Response samples
- 200
- 422
Content type
application/json
Cancel Build
Cancel a specific build job.
Requires authentication to prevent unauthorized build cancellation.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| job_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"success": true,"message": "string"
}Build Vertex Deprecated
Build a vertex instead of the entire graph.
Args:
flow_id (str): The ID of the flow.
vertex_id (str): The ID of the vertex to build.
background_tasks (BackgroundTasks): The background tasks dependency.
inputs (Optional[InputValueRequest], optional): The input values for the vertex. Defaults to None.
files (List[str], optional): The files to use. Defaults to None.
current_user (Any, optional): The current user dependency. Defaults to Depends(get_current_active_user).
Returns:
VertexBuildResponse: The response containing the built vertex information.
Raises:
HTTPException: If there is an error building the vertex.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| flow_id required | |
| vertex_id required |
Request Body schema: application/json
InputValueRequest (object) or null | |
Array of Files (strings) or Files (null) (Files) |
Responses
Request samples
- Payload
Content type
application/json
{
"inputs": {"components": ["components_id","Component Name"
],"input_value": "input_value","session": "session_id"
},"files": ["string"
]
}Response samples
- 200
- 422
Content type
application/json
{
"id": "string","inactivated_vertices": ["string"
],"next_vertices_ids": ["string"
],"top_level_vertices": ["string"
],"valid": true,"params": { },"data": { },"timestamp": "2019-08-24T14:15:22Z"
}Build Vertex Stream Deprecated
Build a vertex instead of the entire graph.
This function is responsible for building a single vertex instead of the entire graph.
It takes the flow_id and vertex_id as required parameters, and an optional session_id.
It also depends on the ChatService and SessionService services.
If session_id is not provided, it retrieves the graph from the cache using the chat_service.
If session_id is provided, it loads the session data using the session_service.
Once the graph is obtained, it retrieves the specified vertex using the vertex_id.
If the vertex does not support streaming, an error is raised.
If the vertex has a built result, it sends the result as a chunk.
If the vertex is not frozen or not built, it streams the vertex data.
If the vertex has a result, it sends the result as a chunk.
If none of the above conditions are met, an error is raised.
If any exception occurs during the process, an error message is sent.
Finally, the stream is closed.
Returns:
A StreamingResponse object with the streamed vertex data in text/event-stream format.
Raises:
HTTPException: If an error occurs while building the vertex.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| flow_id required | |
| vertex_id required |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Build Public Tmp
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
path Parameters
| flow_id required |
query Parameters
Stop Component Id (string) or Stop Component Id (null) (Stop Component Id) | |
Start Component Id (string) or Start Component Id (null) (Start Component Id) | |
Log Builds (boolean) or Log Builds (null) (Log Builds) Default: true | |
Flow Name (string) or Flow Name (null) (Flow Name) | |
| event_delivery | string (EventDeliveryType) Default: "polling" Enum: "streaming" "direct" "polling" |
Request Body schema: application/json
InputValueRequest (object) or null | |
FlowDataRequest (object) or null | |
Array of Files (strings) or Files (null) (Files) |
Responses
Request samples
- Payload
Content type
application/json
{
"inputs": {"components": ["components_id","Component Name"
],"input_value": "input_value","session": "session_id"
},"data": {"viewport": { }
},"files": ["string"
]
}Response samples
- 200
- 422
Content type
application/json
Get All
Retrieve all component types with compression for better performance.
Returns a compressed response containing all available component types.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
Simplified Run Flow
Executes a specified flow by ID with support for streaming and telemetry (API key auth).
This endpoint executes a flow identified by ID or name, with options for streaming the response
and tracking execution metrics. It handles both streaming and non-streaming execution modes.
This endpoint uses API key authentication (Bearer token).
Args:
background_tasks (BackgroundTasks): FastAPI background task manager
flow (FlowRead | None): The flow to execute, loaded via dependency
input_request (SimplifiedAPIRequest | None): Input parameters for the flow
stream (bool): Whether to stream the response
api_key_user (UserRead): Authenticated user from API key
context (dict | None): Optional context to pass to the flow
http_request (Request): The incoming HTTP request for extracting global variables
Returns:
Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results
or a RunResponse with the complete execution results
Raises:
HTTPException: For flow not found (404) or invalid input (400)
APIException: For internal execution errors (500)
Notes:
- Supports both streaming and non-streaming execution modes
- Tracks execution time and success/failure via telemetry
- Handles graceful client disconnection in streaming mode
- Provides detailed error handling with appropriate HTTP status codes
- Extracts global variables from HTTP headers with prefix X-LANGFLOW-GLOBAL-VAR-*
- Merges extracted variables with the context parameter as "request_variables"
- In streaming mode, uses EventManager to handle events:
- "add_message": New messages during execution
- "token": Individual tokens during streaming
- "end": Final execution result
- Authentication: Requires API key (Bearer token)
Authorizations:
API key queryAPI key header
path Parameters
| flow_id_or_name required |
query Parameters
| stream | boolean (Stream) Default: false |
User Id (string) or User Id (string) or User Id (null) (User Id) |
Request Body schema: application/json
SimplifiedAPIRequest (object) or null | |
Context (object) or Context (null) (Context) |
Responses
Request samples
- Payload
Content type
application/json
{
"input_request": {"input_value": "string","input_type": "chat","output_type": "chat","output_component": "","tweaks": {"Component Name": {"parameter_name": "value"
},"component_id": {"parameter_name": "value"
},"parameter_name": "value"
},"session_id": "string"
},"context": { }
}Response samples
- 200
- 422
Content type
application/json
Simplified Run Flow Session
Executes a specified flow by ID with support for streaming and telemetry (session auth).
This endpoint executes a flow identified by ID or name, with options for streaming the response
and tracking execution metrics. It handles both streaming and non-streaming execution modes.
This endpoint uses session-based authentication (cookies).
Args:
background_tasks (BackgroundTasks): FastAPI background task manager
flow (FlowRead | None): The flow to execute, loaded via dependency
input_request (SimplifiedAPIRequest | None): Input parameters for the flow
stream (bool): Whether to stream the response
api_key_user (User): Authenticated user from session
context (dict | None): Optional context to pass to the flow
http_request (Request): The incoming HTTP request for extracting global variables
Returns:
Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results
or a RunResponse with the complete execution results
Raises:
HTTPException: For flow not found (404) or invalid input (400)
APIException: For internal execution errors (500)
Notes:
- Supports both streaming and non-streaming execution modes
- Tracks execution time and success/failure via telemetry
- Handles graceful client disconnection in streaming mode
- Provides detailed error handling with appropriate HTTP status codes
- Extracts global variables from HTTP headers with prefix X-LANGFLOW-GLOBAL-VAR-*
- Merges extracted variables with the context parameter as "request_variables"
- In streaming mode, uses EventManager to handle events:
- "add_message": New messages during execution
- "token": Individual tokens during streaming
- "end": Final execution result
- Authentication: Requires active session (cookies)
- Feature Flag: Only available when agentic_experience is enabled
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| flow_id_or_name required |
query Parameters
| stream | boolean (Stream) Default: false |
User Id (string) or User Id (string) or User Id (null) (User Id) |
Request Body schema: application/json
SimplifiedAPIRequest (object) or null | |
Context (object) or Context (null) (Context) |
Responses
Request samples
- Payload
Content type
application/json
{
"input_request": {"input_value": "string","input_type": "chat","output_type": "chat","output_component": "","tweaks": {"Component Name": {"parameter_name": "value"
},"component_id": {"parameter_name": "value"
},"parameter_name": "value"
},"session_id": "string"
},"context": { }
}Response samples
- 200
- 422
Content type
application/json
Webhook Run Flow
Run a flow using a webhook request.
Args:
flow_id_or_name (str): The flow ID or endpoint name.
flow (Flow): The flow to be executed.
request (Request): The incoming HTTP request.
background_tasks (BackgroundTasks): The background tasks manager.
Returns:
dict: A dictionary containing the status of the task.
Raises:
HTTPException: If the flow is not found or if there is an error processing the request.
path Parameters
| flow_id_or_name required |
query Parameters
User Id (string) or User Id (string) or User Id (null) (User Id) |
Responses
Response samples
- 202
- 422
Content type
application/json
Experimental Run Flow
Executes a specified flow by ID with optional input values, output selection, tweaks, and streaming capability.
This endpoint supports running flows with caching to enhance performance and efficiency.
### Parameters:
- flow (Flow): The flow object to be executed, resolved via dependency injection.
- inputs (List[InputValueRequest], optional): A list of inputs specifying the input values and components
for the flow. Each input can target specific components and provide custom values.
- outputs (List[str], optional): A list of output names to retrieve from the executed flow.
If not provided, all outputs are returned.
- tweaks (Optional[Tweaks], optional): A dictionary of tweaks to customize the flow execution.
The tweaks can be used to modify the flow's parameters and components.
Tweaks can be overridden by the input values.
- stream (bool, optional): Specifies whether the results should be streamed. Defaults to False.
- session_id (Union[None, str], optional): An optional session ID to utilize existing session data for the flow
execution.
- api_key_user (User): The user associated with the current API key. Automatically resolved from the API key.
### Returns:
A RunResponse object containing the selected outputs (or all if not specified) of the executed flow
and the session ID.
The structure of the response accommodates multiple inputs, providing a nested list of outputs for each input.
### Raises:
HTTPException: Indicates issues with finding the specified flow, invalid input formats, or internal errors during
flow execution.
### Example usage:json<br>POST /run/flow_id<br>x-api-key: YOUR_API_KEY<br>Payload:<br>{<br> "inputs": [<br> {"components": ["component1"], "input_value": "value1"},<br> {"components": ["component3"], "input_value": "value2"}<br> ],<br> "outputs": ["Component Name", "component_id"],<br> "tweaks": {"parameter_name": "value", "Component Name": {"parameter_name": "value"}, "component_id": {"parameter_name": "value"}}<br> "stream": false<br>}<br>
This endpoint facilitates complex flow executions with customized inputs, outputs, and configurations,
catering to diverse application requirements.
Authorizations:
API key queryAPI key header
path Parameters
| flow_id_or_name required |
query Parameters
User Id (string) or User Id (string) or User Id (null) (User Id) |
Request Body schema: application/json
Array of Inputs (objects) or Inputs (null) (Inputs) | |
Array of Outputs (strings) or Outputs (null) (Outputs) | |
| stream | boolean (Stream) Default: false |
Session Id (string) or Session Id (null) (Session Id) |
Responses
Request samples
- Payload
Content type
application/json
{
"inputs": [{"components": ["components_id","Component Name"
],"input_value": "input_value","session": "session_id"
}
],"outputs": ["string"
],"tweaks": {"Component Name": {"parameter_name": "value"
},"component_id": {"parameter_name": "value"
},"parameter_name": "value"
},"stream": false,"session_id": "string"
}Response samples
- 200
- 422
Content type
application/json
{
"outputs": [ ],"session_id": "string"
}Process
Endpoint to process an input with a given flow_id.
Authorizations:
API key queryAPI key header
path Parameters
| _flow_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
Process
Endpoint to process an input with a given flow_id.
Authorizations:
API key queryAPI key header
path Parameters
| _flow_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
Get Task Status Deprecated
Get the status of a task by ID (Deprecated).
This endpoint is deprecated and will be removed in a future version.
path Parameters
| _task_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"status": "string","result": { }
}Create Upload File Deprecated
Upload a file for a specific flow (Deprecated).
This endpoint is deprecated and will be removed in a future version.
path Parameters
| flow_id required |
Request Body schema: multipart/form-data
required
| file required |
Responses
Response samples
- 201
- 422
Content type
application/json
{
"flowId": "string","file_path": "string"
}Custom Component
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| code required | |
Frontend Node (object) or Frontend Node (null) (Frontend Node) |
Responses
Request samples
- Payload
Content type
application/json
{
"code": "string","frontend_node": { }
}Response samples
- 200
- 422
Content type
application/json
{
"data": { },"type": "string"
}Custom Component Update
Update an existing custom component with new code and configuration.
Processes the provided code and template updates, applies parameter changes (including those loaded from the
database), updates the component's build configuration, and validates outputs. Returns the updated component node as
a JSON-serializable dictionary.
Raises:
HTTPException: If an error occurs during component building or updating.
SerializationError: If serialization of the updated component node fails.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| code required | string (Code) |
Frontend Node (object) or Frontend Node (null) (Frontend Node) | |
| field required | string (Field) |
Field Value (string) or Field Value (integer) or Field Value (number) or Field Value (boolean) or Field Value (object) or Array of Field Value (any) or Field Value (null) (Field Value) | |
required | object (Template) |
| tool_mode | boolean (Tool Mode) Default: false |
Responses
Request samples
- Payload
Content type
application/json
{
"code": "string","frontend_node": { },"field": "string","field_value": "string","template": { },"tool_mode": false
}Response samples
- 200
- 422
Content type
application/json
Get Config
Retrieve the current application configuration settings.
Requires authentication to prevent exposure of sensitive configuration details.
Returns:
ConfigResponse: The configuration settings of the application.
Raises:
HTTPException: If an error occurs while retrieving the configuration.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
{
"feature_flags": {"mvp_components": false
},"serialization_max_items_length": 0,"serialization_max_text_length": 0,"frontend_timeout": 0,"auto_saving": true,"auto_saving_interval": 0,"health_check_max_retries": 0,"max_file_size_upload": 0,"webhook_polling_interval": 0,"public_flow_cleanup_interval": 0,"public_flow_expiration": 0,"event_delivery": "polling","webhook_auth_enable": true,"voice_mode_available": true,"default_folder_name": "string","hide_getting_started_progress": true
}Post Validate Code
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| code required |
Responses
Request samples
- Payload
Content type
application/json
Response samples
- 200
- 422
Content type
application/json
{
"imports": { },"function": { }
}Post Validate Prompt
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| name required | |
| template required | |
Custom Fields (object) or Custom Fields (null) (Custom Fields) | |
FrontendNodeRequest (object) or null |
Responses
Request samples
- Payload
Content type
application/json
{
"name": "string","template": "string","custom_fields": { },"frontend_node": {"template": { },"description": "string","icon": "string","is_input": true,"is_output": true,"is_composition": true,"base_classes": ["string"
],"name": "","display_name": "","priority": 0,"documentation": "","minimized": false,"custom_fields": { },"output_types": [ ],"full_path": "string","pinned": false,"conditional_paths": [ ],"frozen": false,"outputs": [ ],"field_order": [ ],"beta": false,"legacy": false,"replacement": ["string"
],"error": "string","edited": false,"metadata": { },"tool_mode": false
}
}Response samples
- 200
- 422
Content type
application/json
{
"input_variables": [null
],"frontend_node": {"template": { },"description": "string","icon": "string","is_input": true,"is_output": true,"is_composition": true,"base_classes": ["string"
],"name": "","display_name": "string","priority": 0,"documentation": "","minimized": false,"custom_fields": { },"output_types": [ ],"full_path": "string","pinned": false,"conditional_paths": [ ],"frozen": false,"outputs": [ ],"field_order": [ ],"beta": false,"legacy": false,"replacement": ["string"
],"error": "string","edited": false,"metadata": { },"tool_mode": false
}
}Response samples
- 200
Content type
application/json
Get Components
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
Component Id (string) or Component Id (null) (Component Id) | |
Search (string) or Search (null) (Search) | |
Private (boolean) or Private (null) (Private) | |
Is Component (boolean) or Is Component (null) (Is Component) | |
Array of Tags (strings) or Tags (null) (Tags) | |
Array of Sort (strings) or Sort (null) (Sort) | |
| liked | boolean (Liked) Default: false |
| filter_by_user | boolean (Filter By User) Default: false |
Array of Fields (strings) or Fields (null) (Fields) | |
| page | integer (Page) Default: 1 |
| limit | integer (Limit) Default: 10 |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"count": 0,"authorized": true,"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","description": "string","liked_by_count": 0,"liked_by_user": true,"is_component": true,"metadata": { },"user_created": { },"tags": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string"
}
],"downloads_count": 0,"last_tested_version": "string","private": true
}
]
}Download Component
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| component_id required | string <uuid> (Component Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","description": "string","data": { },"is_component": true,"metadata": { }
}Get List Of Components Liked By User
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
[
{"likes_count": 0,"liked_by_user": true
}
]Like Component
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| component_id required | string <uuid> (Component Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"likes_count": 0,"liked_by_user": true
}Create Flow
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| name required | string (Name) |
Description (string) or Description (null) (Description) | |
Icon (string) or Icon (null) (Icon) | |
Icon Bg Color (string) or Icon Bg Color (null) (Icon Bg Color) | |
Gradient (string) or Gradient (null) (Gradient) | |
Data (object) or Data (null) (Data) | |
Is Component (boolean) or Is Component (null) (Is Component) Default: false | |
Updated At (string) or Updated At (null) (Updated At) | |
Webhook (boolean) or Webhook (null) (Webhook) Default: false Can be used on the webhook endpoint | |
Endpoint Name (string) or Endpoint Name (null) (Endpoint Name) | |
Array of Tags (strings) or Tags (null) (Tags) | |
Locked (boolean) or Locked (null) (Locked) Default: false | |
Mcp Enabled (boolean) or Mcp Enabled (null) (Mcp Enabled) Default: false Can be exposed in the MCP server | |
Action Name (string) or Action Name (null) (Action Name) The name of the action associated with the flow | |
Action Description (string) or Action Description (null) (Action Description) The description of the action associated with the flow | |
| access_type | string (AccessTypeEnum) Default: "PRIVATE" Enum: "PRIVATE" "PUBLIC" |
User Id (string) or User Id (null) (User Id) | |
Folder Id (string) or Folder Id (null) (Folder Id) | |
Fs Path (string) or Fs Path (null) (Fs Path) |
Responses
Request samples
- Payload
Content type
application/json
{
"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","tags": ["string"
],"locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901","fs_path": "string"
}Response samples
- 201
- 422
Content type
application/json
{
"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","tags": ["string"
],"locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}Read Flows
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.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
| remove_example_flows | boolean (Remove Example Flows) Default: false |
| components_only | boolean (Components Only) Default: false |
| get_all | boolean (Get All) Default: true |
Folder Id (string) or Folder Id (null) (Folder Id) | |
| header_flows | boolean (Header Flows) Default: false |
| page | integer (Page) >= 1 Default: 1 |
| size | integer (Size) [ 1 .. 100 ] Default: 50 |
Responses
Response samples
- 200
- 422
Content type
application/json
Example
Delete Multiple Flows
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.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
Responses
Request samples
- Payload
Content type
application/json
[
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 422
Content type
application/json
Read Flow
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| flow_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","tags": ["string"
],"locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}Update Flow
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| flow_id required |
Request Body schema: application/json
required
Name (string) or Name (null) (Name) | |
Description (string) or Description (null) (Description) | |
Data (object) or Data (null) (Data) | |
Folder Id (string) or Folder Id (null) (Folder Id) | |
Endpoint Name (string) or Endpoint Name (null) (Endpoint Name) | |
Mcp Enabled (boolean) or Mcp Enabled (null) (Mcp Enabled) | |
Locked (boolean) or Locked (null) (Locked) | |
Action Name (string) or Action Name (null) (Action Name) | |
Action Description (string) or Action Description (null) (Action Description) | |
AccessTypeEnum (string) or null | |
Fs Path (string) or Fs Path (null) (Fs Path) |
Responses
Request samples
- Payload
Content type
application/json
{
"name": "string","description": "string","data": { },"folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901","endpoint_name": "string","mcp_enabled": true,"locked": true,"action_name": "string","action_description": "string","access_type": "PRIVATE","fs_path": "string"
}Response samples
- 200
- 422
Content type
application/json
{
"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","tags": ["string"
],"locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}Delete Flow
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| flow_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
Response samples
- 200
- 422
Content type
application/json
{
"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","tags": ["string"
],"locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}Create Flows
Create multiple new flows.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
required | |||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||
Responses
Request samples
- Payload
Content type
application/json
{
"flows": [{"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901","fs_path": "string"
}
]
}Response samples
- 201
- 422
Content type
application/json
[
{"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}
]Upload File
Upload flows from a file.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
Folder Id (string) or Folder Id (null) (Folder Id) |
Request Body schema: multipart/form-data
required
| file required |
Responses
Response samples
- 201
- 422
Content type
application/json
[
{"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}
]Download Multiple File
Download all flows as a zip file.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
Responses
Request samples
- Payload
Content type
application/json
[
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 422
Content type
application/json
Read Basic Examples
Retrieve a list of basic example flows.
Args:
session (Session): The database session.
Returns:
list[FlowRead]: A list of basic example flows.
Responses
Response samples
- 200
Content type
application/json
[
{"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}
]Get Starter Projects
Get a list of starter projects.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
[
{"data": {"viewport": {"x": 0,"y": 0,"zoom": 0
}
},"is_component": true,"name": "string","description": "string","endpoint_name": "string"
}
]Add User
Add a new user to the database.
Requires superuser authentication to prevent unauthorized account creation.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| username required | |
| password required | |
Optins (object) or Optins (null) (Optins) Default: {"github_starred":false,"dialog_dismissed":false,"discord_clicked":false} |
Responses
Request samples
- Payload
Content type
application/json
{
"username": "string","password": "string","optins": {"github_starred": false,"dialog_dismissed": false,"discord_clicked": false
}
}Response samples
- 201
- 422
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","username": "string","profile_image": "string","store_api_key": "string","is_active": true,"is_superuser": true,"create_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","last_login_at": "2019-08-24T14:15:22Z","optins": { }
}Read All Users
Retrieve a list of users from the database with pagination.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
| skip | integer (Skip) Default: 0 |
| limit | integer (Limit) Default: 10 |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"total_count": 0,"users": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","username": "string","profile_image": "string","store_api_key": "string","is_active": true,"is_superuser": true,"create_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","last_login_at": "2019-08-24T14:15:22Z","optins": { }
}
]
}Read Current User
Retrieve the current user's data.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","username": "string","profile_image": "string","store_api_key": "string","is_active": true,"is_superuser": true,"create_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","last_login_at": "2019-08-24T14:15:22Z","optins": { }
}Patch User
Update an existing user's data.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| user_id required |
Request Body schema: application/json
required
Username (string) or Username (null) (Username) | |
Profile Image (string) or Profile Image (null) (Profile Image) | |
Password (string) or Password (null) (Password) | |
Is Active (boolean) or Is Active (null) (Is Active) | |
Is Superuser (boolean) or Is Superuser (null) (Is Superuser) | |
Last Login At (string) or Last Login At (null) (Last Login At) | |
Optins (object) or Optins (null) (Optins) |
Responses
Request samples
- Payload
Content type
application/json
{
"username": "string","profile_image": "string","password": "string","is_active": true,"is_superuser": true,"last_login_at": "2019-08-24T14:15:22Z","optins": { }
}Response samples
- 200
- 422
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","username": "string","profile_image": "string","store_api_key": "string","is_active": true,"is_superuser": true,"create_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","last_login_at": "2019-08-24T14:15:22Z","optins": { }
}Delete User
Delete a user from the database.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| user_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
Reset Password
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| user_id required |
Request Body schema: application/json
required
Username (string) or Username (null) (Username) | |
Profile Image (string) or Profile Image (null) (Profile Image) | |
Password (string) or Password (null) (Password) | |
Is Active (boolean) or Is Active (null) (Is Active) | |
Is Superuser (boolean) or Is Superuser (null) (Is Superuser) | |
Last Login At (string) or Last Login At (null) (Last Login At) | |
Optins (object) or Optins (null) (Optins) |
Responses
Request samples
- Payload
Content type
application/json
{
"username": "string","profile_image": "string","password": "string","is_active": true,"is_superuser": true,"last_login_at": "2019-08-24T14:15:22Z","optins": { }
}Response samples
- 200
- 422
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","username": "string","profile_image": "string","store_api_key": "string","is_active": true,"is_superuser": true,"create_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","last_login_at": "2019-08-24T14:15:22Z","optins": { }
}Response samples
- 200
Content type
application/json
{
"total_count": 0,"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","api_keys": [{"name": "string","last_used_at": "2019-08-24T14:15:22Z","total_uses": 0,"is_active": true,"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","api_key": "string","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","created_at": "2019-08-24T14:15:22Z"
}
]
}Create Api Key Route
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
Name (string) or Name (null) (Name) | |
Last Used At (string) or Last Used At (null) (Last Used At) | |
| total_uses | integer (Total Uses) Default: 0 |
| is_active | boolean (Is Active) Default: true |
Api Key (string) or Api Key (null) (Api Key) | |
User Id (string) or User Id (null) (User Id) | |
Created At (string) or Created At (null) (Created At) |
Responses
Request samples
- Payload
Content type
application/json
{
"name": "string","last_used_at": "2019-08-24T14:15:22Z","total_uses": 0,"is_active": true,"api_key": "string","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","created_at": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 422
Content type
application/json
{
"name": "string","last_used_at": "2019-08-24T14:15:22Z","total_uses": 0,"is_active": true,"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","api_key": "string","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}Delete Api Key Route
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| api_key_id required | string <uuid> (Api Key Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
Save Store Api Key
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| api_key required |
Responses
Request samples
- Payload
Content type
application/json
{
"api_key": "string"
}Response samples
- 200
- 422
Content type
application/json
Login To Get Access Token
Request Body schema: application/x-www-form-urlencoded
required
Grant Type (string) or Grant Type (null) (Grant Type) | |
| username required | string (Username) |
| password required | string <password> (Password) |
| scope | string (Scope) Default: "" |
Client Id (string) or Client Id (null) (Client Id) | |
Client Secret (string) or Client Secret (null) <password> (Client Secret) |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"access_token": "string","refresh_token": "string","token_type": "string"
}Response samples
- 200
Content type
application/json
[
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","type": "string","value": "string","default_fields": ["string"
]
}
]Create Variable
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| name required | string (Name) Name of the variable |
| value required | string (Value) Encrypted value of the variable |
required | Array of Default Fields (strings) or Default Fields (null) (Default Fields) |
Type (string) or Type (null) (Type) Type of the variable | |
Created At (string) or Created At (null) (Created At) Creation time of the variable | |
Updated At (string) or Updated At (null) (Updated At) Creation time of the variable |
Responses
Request samples
- Payload
Content type
application/json
{
"name": "string","value": "string","default_fields": ["string"
],"type": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"
}Response samples
- 201
- 422
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","type": "string","value": "string","default_fields": ["string"
]
}Update Variable
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| variable_id required | string <uuid> (Variable Id) |
Request Body schema: application/json
required
| id required | |
Name (string) or Name (null) (Name) | |
Value (string) or Value (null) (Value) Encrypted value of the variable | |
Array of Default Fields (strings) or Default Fields (null) (Default Fields) Default fields for the variable |
Responses
Request samples
- Payload
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","value": "string","default_fields": ["string"
]
}Response samples
- 200
- 422
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","type": "string","value": "string","default_fields": ["string"
]
}Delete Variable
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| variable_id required | string <uuid> (Variable Id) |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Upload File
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| flow_id required |
Request Body schema: multipart/form-data
required
| file required |
Responses
Response samples
- 201
- 422
Content type
application/json
{
"flowId": "string","file_path": "string"
}Download File
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| file_name required | |
| flow_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
Download Image
Download image from storage for browser rendering.
path Parameters
| flow_id required | |
| file_name required |
Responses
Response samples
- 200
- 422
Content type
application/json
Download Profile Picture
Download profile picture from local filesystem.
Profile pictures are first looked up in config_dir/profile_pictures/,
then fallback to the package's bundled profile_pictures directory.
path Parameters
| folder_name required | |
| file_name required |
Responses
Response samples
- 200
- 422
Content type
application/json
List Profile Pictures
List profile pictures from local filesystem.
Profile pictures are first looked up in config_dir/profile_pictures/,
then fallback to the package's bundled profile_pictures directory.
Responses
Response samples
- 200
Content type
application/json
List Files
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| flow_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
Delete File
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| file_name required | |
| flow_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
Upload User File
Upload a file for the current user and track it in the database.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
| append | boolean (Append) Default: false |
Request Body schema: multipart/form-data
required
| file required |
Responses
Response samples
- 201
- 422
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","path": "string","size": 0,"provider": "string"
}List Files
List the files available to the current user.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
[
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","name": "string","path": "string","size": 0,"provider": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"
}
]Delete All Files
Delete all files for the current user.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
Upload User File
Upload a file for the current user and track it in the database.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
| append | boolean (Append) Default: false |
Request Body schema: multipart/form-data
required
| file required |
Responses
Response samples
- 201
- 422
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","path": "string","size": 0,"provider": "string"
}List Files
List the files available to the current user.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
[
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","name": "string","path": "string","size": 0,"provider": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"
}
]Delete All Files
Delete all files for the current user.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
Download Files Batch
Download multiple files as a zip file by their IDs.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
Responses
Request samples
- Payload
Content type
application/json
[
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 422
Content type
application/json
Delete Files Batch
Delete multiple files by their IDs.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
Responses
Request samples
- Payload
Content type
application/json
[
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 200
- 422
Content type
application/json
Download File
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.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| file_id required |
query Parameters
| return_content | boolean (Return Content) Default: false |
Responses
Response samples
- 200
- 422
Content type
application/json
Edit File Name
Edit the name of a file by its ID.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| file_id required |
query Parameters
| name required |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","path": "string","size": 0,"provider": "string"
}Delete File
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| file_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
Get Vertex Builds
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
| flow_id required |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"vertex_builds": {"property1": [{"timestamp": "2019-08-24T14:15:22Z","id": "string","data": { },"artifacts": { },"params": "string","valid": true,"flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2","build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb"
}
],"property2": [{"timestamp": "2019-08-24T14:15:22Z","id": "string","data": { },"artifacts": { },"params": "string","valid": true,"flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2","build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb"
}
]
}
}Delete Vertex Builds
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
| flow_id required |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Get Message Sessions
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
Flow Id (string) or Flow Id (null) (Flow Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
Get Messages
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
Flow Id (string) or Flow Id (null) (Flow Id) | |
Session Id (string) or Session Id (null) (Session Id) | |
Sender (string) or Sender (null) (Sender) | |
Sender Name (string) or Sender Name (null) (Sender Name) | |
Order By (string) or Order By (null) (Order By) Default: "timestamp" |
Responses
Response samples
- 200
- 422
Content type
application/json
[
{"id": "string","flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2","timestamp": "2019-08-24T14:15:22Z","sender": "string","sender_name": "string","session_id": "string","context_id": "string","text": "string","files": [ ],"edit": true,"duration": 0,"properties": {"text_color": "string","background_color": "string","edited": false,"source": {"id": "string","display_name": "string","source": "string"
},"icon": "string","allow_markdown": false,"positive_feedback": true,"state": "partial","targets": [ ]
},"category": "string","content_blocks": [{"title": "string","allow_markdown": true,
}
]
}
]Delete Messages
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
Responses
Request samples
- Payload
Content type
application/json
[
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Update Message
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| message_id required | string <uuid> (Message Id) |
Request Body schema: application/json
required
Text (string) or Text (null) (Text) | |
Sender (string) or Sender (null) (Sender) | |
Sender Name (string) or Sender Name (null) (Sender Name) | |
Session Id (string) or Session Id (null) (Session Id) | |
Context Id (string) or Context Id (null) (Context Id) | |
Array of Files (strings) or Files (null) (Files) | |
Edit (boolean) or Edit (null) (Edit) | |
Error (boolean) or Error (null) (Error) | |
Properties (object) or null |
Responses
Request samples
- Payload
Content type
application/json
{
"text": "string","sender": "string","sender_name": "string","session_id": "string","context_id": "string","files": ["string"
],"edit": true,"error": true,"properties": {"text_color": "string","background_color": "string","edited": false,"source": {"id": "string","display_name": "string","source": "string"
},"icon": "string","allow_markdown": false,"positive_feedback": true,"state": "partial","targets": [ ]
}
}Response samples
- 200
- 422
Content type
application/json
{
"timestamp": "2019-08-24T14:15:22Z","sender": "string","sender_name": "string","session_id": "string","context_id": "string","text": "string","files": ["string"
],"error": false,"edit": false,"properties": {"text_color": "string","background_color": "string","edited": false,"source": {"id": "string","display_name": "string","source": "string"
},"icon": "string","allow_markdown": false,"positive_feedback": true,"state": "partial","targets": [ ]
},"category": "message","content_blocks": [{"title": "string","allow_markdown": true,
}
],"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2"
}Update Session Id
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| old_session_id required |
query Parameters
| new_session_id required | string (New Session Id) The new session ID to update to |
Responses
Response samples
- 200
- 422
Content type
application/json
[
{"id": "string","flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2","timestamp": "2019-08-24T14:15:22Z","sender": "string","sender_name": "string","session_id": "string","context_id": "string","text": "string","files": [ ],"edit": true,"duration": 0,"properties": {"text_color": "string","background_color": "string","edited": false,"source": {"id": "string","display_name": "string","source": "string"
},"icon": "string","allow_markdown": false,"positive_feedback": true,"state": "partial","targets": [ ]
},"category": "string","content_blocks": [{"title": "string","allow_markdown": true,
}
]
}
]Delete Messages Session
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| session_id required |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Get Transactions
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
| flow_id required | |
| page | integer (Page) >= 1 Default: 1 |
| size | integer (Size) [ 1 .. 100 ] Default: 50 |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"items": [{"timestamp": "2019-08-24T14:15:22Z","vertex_id": "string","target_id": "string","inputs": { },"outputs": { },"status": "string","error": "string","flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],"total": 0,"page": 1,"size": 1,"pages": 0
}Response samples
- 200
Content type
application/json
[
{"name": "string","description": "string","auth_settings": { },"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}
]Response samples
- 201
Content type
application/json
{
"name": "string","description": "string","auth_settings": { },"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}Read Folder Redirect
Redirect to the projects endpoint.
path Parameters
| folder_id required | string <uuid> (Folder Id) |
query Parameters
| is_component | boolean (Is Component) Default: false |
| is_flow | boolean (Is Flow) Default: false |
| search | string (Search) Default: "" |
Page (integer) or Page (null) (Page) | |
Size (integer) or Size (null) (Size) |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"folder": {"name": "string","description": "string","auth_settings": { },"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
},"flows": {"items": [{"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","tags": [ ],"locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901","fs_path": "string"
}
],"total": 0,"page": 1,"size": 1,"pages": 0
}
}Update Folder Redirect
Redirect to the projects endpoint.
path Parameters
| folder_id required | string <uuid> (Folder Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"name": "string","description": "string","auth_settings": { },"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}Delete Folder Redirect
Redirect to the projects endpoint.
path Parameters
| folder_id required | string <uuid> (Folder Id) |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Download File Redirect
Redirect to the projects endpoint.
path Parameters
| folder_id required | string <uuid> (Folder Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
Response samples
- 201
Content type
application/json
[
{"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}
]Response samples
- 200
Content type
application/json
[
{"name": "string","description": "string","auth_settings": { },"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}
]Create Project
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| name required | |
Description (string) or Description (null) (Description) | |
Auth Settings (object) or Auth Settings (null) (Auth Settings) Authentication settings for the folder/project | |
Array of Components List (strings) or Components List (null) (Components List) | |
Array of Flows List (strings) or Flows List (null) (Flows List) |
Responses
Request samples
- Payload
Content type
application/json
{
"name": "string","description": "string","auth_settings": { },"components_list": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],"flows_list": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}Response samples
- 201
- 422
Content type
application/json
{
"name": "string","description": "string","auth_settings": { },"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}Read Project
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| project_id required | string <uuid> (Project Id) |
query Parameters
Page (integer) or Page (null) (Page) | |
Size (integer) or Size (null) (Size) | |
| is_component | boolean (Is Component) Default: false |
| is_flow | boolean (Is Flow) Default: false |
| search | string (Search) Default: "" |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"folder": {"name": "string","description": "string","auth_settings": { },"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
},"flows": {"items": [{"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","tags": [ ],"locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901","fs_path": "string"
}
],"total": 0,"page": 1,"size": 1,"pages": 0
}
}Update Project
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| project_id required | string <uuid> (Project Id) |
Request Body schema: application/json
required
Name (string) or Name (null) (Name) | |
Description (string) or Description (null) (Description) | |
Parent Id (string) or Parent Id (null) (Parent Id) | |
| components | Array of strings <uuid> (Components) [ items <uuid > ] |
| flows | Array of strings <uuid> (Flows) [ items <uuid > ] |
Auth Settings (object) or Auth Settings (null) (Auth Settings) |
Responses
Request samples
- Payload
Content type
application/json
{
"name": "string","description": "string","parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef","components": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],"flows": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],"auth_settings": { }
}Response samples
- 200
- 422
Content type
application/json
{
"name": "string","description": "string","auth_settings": { },"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}Delete Project
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Download File
Download all flows from project as a zip file.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
Upload File
Upload flows from a file.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: multipart/form-data
required
| file required |
Responses
Response samples
- 201
- 422
Content type
application/json
[
{"name": "string","description": "string","icon": "string","icon_bg_color": "string","gradient": "string","data": { },"is_component": false,"updated_at": "2019-08-24T14:15:22Z","webhook": false,"endpoint_name": "string","locked": false,"mcp_enabled": false,"action_name": "string","action_description": "string","access_type": "PRIVATE","id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","user_id": "a169451c-8525-4352-b8ca-070dd449a1a5","folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"
}
]List Knowledge Bases
List all available knowledge bases.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
[
{"id": "string","name": "string","embedding_provider": "Unknown","embedding_model": "Unknown","size": 0,"words": 0,"characters": 0,"chunks": 0,"avg_chunk_size": 0
}
]Delete Knowledge Bases Bulk
Delete multiple knowledge bases.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| kb_names required | Array of strings (Kb Names) |
Responses
Request samples
- Payload
Content type
application/json
{
"kb_names": ["string"
]
}Response samples
- 200
- 422
Content type
application/json
List Knowledge Bases
List all available knowledge bases.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
[
{"id": "string","name": "string","embedding_provider": "Unknown","embedding_model": "Unknown","size": 0,"words": 0,"characters": 0,"chunks": 0,"avg_chunk_size": 0
}
]Delete Knowledge Bases Bulk
Delete multiple knowledge bases.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Request Body schema: application/json
required
| kb_names required | Array of strings (Kb Names) |
Responses
Request samples
- Payload
Content type
application/json
{
"kb_names": ["string"
]
}Response samples
- 200
- 422
Content type
application/json
Get Knowledge Base
Get detailed information about a specific knowledge base.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| kb_name required |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"id": "string","name": "string","embedding_provider": "Unknown","embedding_model": "Unknown","size": 0,"words": 0,"characters": 0,"chunks": 0,"avg_chunk_size": 0
}Delete Knowledge Base
Delete a specific knowledge base.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| kb_name required |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"property1": "string","property2": "string"
}Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Handle Streamable Http
Streamable HTTP endpoint for MCP clients that support the new transport.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Get Elevenlabs Voice Ids
Get available voice IDs from ElevenLabs API.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
Handle Project Messages
Handle POST messages for a project-specific MCP server.
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
Update Project Mcp Settings
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.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| project_id required | string <uuid> (Project Id) |
Request Body schema: application/json
required
required | Array of objects (Settings) |
AuthSettings (object) or null |
Responses
Request samples
- Payload
Content type
application/json
{
"settings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","mcp_enabled": true,"action_name": "string","action_description": "string","name": "string","description": "string"
}
],"auth_settings": {"auth_type": "none","oauth_host": "string","oauth_port": "string","oauth_server_url": "string","oauth_callback_path": "string","oauth_client_id": "string","oauth_client_secret": "pa$$word","oauth_auth_url": "string","oauth_token_url": "string","oauth_mcp_scope": "string","oauth_provider_scope": "string"
}
}Response samples
- 200
- 422
Content type
application/json
Handle Project Sse
Handle SSE connections for a specific project.
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Handle Project Messages
Handle POST messages for a project-specific MCP server.
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
Handle Project Streamable Http
Handle Streamable HTTP connections for a specific project.
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Handle Project Streamable Http
Handle Streamable HTTP connections for a specific project.
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Handle Project Streamable Http
Handle Streamable HTTP connections for a specific project.
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Handle Project Streamable Http
Handle Streamable HTTP connections for a specific project.
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Handle Project Streamable Http
Handle Streamable HTTP connections for a specific project.
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Handle Project Streamable Http
Handle Streamable HTTP connections for a specific project.
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 422
Content type
application/json
{
"detail": [{"msg": "string","type": "string"
}
]
}Install Mcp Config
Install MCP server configuration for Cursor, Windsurf, or Claude.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| project_id required | string <uuid> (Project Id) |
Request Body schema: application/json
required
| client required | |
Transport (string) or Transport (null) (Transport) |
Responses
Request samples
- Payload
Content type
application/json
{
"client": "string","transport": "sse"
}Response samples
- 200
- 422
Content type
application/json
Get Project Composer Url
Get the MCP Composer URL for a specific project.
On failure, this endpoint should return with a 200 status code and an error message in
the body of the response to display to the user.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
{
"project_id": "string","uses_composer": true,"streamable_http_url": "string","legacy_sse_url": "string","error_message": "string"
}Check Installed Mcp Servers
Check if MCP server configuration is installed for this project in Cursor, Windsurf, or Claude.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| project_id required | string <uuid> (Project Id) |
Responses
Response samples
- 200
- 422
Content type
application/json
Create Response
Create a response using OpenAI Responses API format.
This endpoint accepts a flow_id in the model parameter and processes
the input through the specified Langflow flow.
Args:
request: OpenAI Responses API request with model (flow_id) and input
background_tasks: FastAPI background task manager
api_key_user: Authenticated user from API key
http_request: The incoming HTTP request
telemetry_service: Telemetry service for logging
Returns:
OpenAI-compatible response or streaming response
Raises:
HTTPException: For validation errors or flow execution issues
Authorizations:
API key queryAPI key header
Request Body schema: application/json
required
| model required | string (Model) The flow ID to execute (used instead of OpenAI model) |
| input required | string (Input) The input text to process |
| stream | boolean (Stream) Default: false Whether to stream the response |
| background | boolean (Background) Default: false Whether to process in background |
Array of Tools (any) or Tools (null) (Tools) Tools are not supported yet | |
Previous Response Id (string) or Previous Response Id (null) (Previous Response Id) ID of previous response to continue conversation | |
Array of Include (strings) or Include (null) (Include) Additional response data to include, e.g., ['tool_call.results'] |
Responses
Request samples
- Payload
Content type
application/json
{
"model": "string","input": "string","stream": false,"background": false,"tools": [null
],"previous_response_id": "string","include": ["string"
]
}Response samples
- 200
- 422
Content type
application/json
Get Servers
Get the list of available servers.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
Action Count (boolean) or Action Count (null) (Action Count) |
Responses
Response samples
- 200
- 422
Content type
application/json
Get Server Endpoint
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| server_name required |
Responses
Response samples
- 200
- 422
Content type
application/json
Add Server
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| server_name required |
Request Body schema: application/json
required
| property name* additional property |
Responses
Request samples
- Payload
Content type
application/json
Response samples
- 200
- 422
Content type
application/json
Update Server Endpoint
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| server_name required |
Request Body schema: application/json
required
| property name* additional property |
Responses
Request samples
- Payload
Content type
application/json
Response samples
- 200
- 422
Content type
application/json
Delete Server
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
path Parameters
| server_name required |
Responses
Response samples
- 200
- 422
Content type
application/json
Get Registration
Get the registered user (if any).
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
Register User
Register the single user with email.
Note: Only one registration is allowed.
Request Body schema: application/json
required
| email required |
Responses
Request samples
- Payload
Content type
application/json
{
"email": "user@example.com"
}Response samples
- 200
- 422
Content type
application/json
Response samples
- 200
Content type
application/json
{
"status": "nok","chat": "error check the server logs","db": "error check the server logs"
}Stream Logs
HTTP/2 Server-Sent-Event (SSE) endpoint for streaming logs.
Requires authentication to prevent exposure of sensitive log data.
It establishes a long-lived connection to the server and receives log messages in real-time.
The client should use the header "Accept: text/event-stream".
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
Responses
Response samples
- 200
Content type
application/json
Logs
Retrieve application logs with authentication required.
SECURITY: Logs may contain sensitive information and require authentication.
Authorizations:
OAuth2PasswordBearerAPI key queryAPI key header
query Parameters
| lines_before | integer (Lines Before) Default: 0 The number of logs before the timestamp or the last log |
| lines_after | integer (Lines After) Default: 0 The number of logs after the timestamp |
| timestamp | integer (Timestamp) Default: 0 The timestamp to start getting logs from |
Responses
Response samples
- 200
- 422
Content type
application/json