{
"opencollection": "1.0.0",
"info": {
"name": "Langflow Base API",
"version": "1.9.0"
},
"items": [
{
"info": {
"name": "Base",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get All",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/all",
"auth": {
"type": "oauth2",
"flow": "resource_owner_password_credentials",
"accessTokenUrl": "api/v1/login",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieve all component types with compression for better performance.
Returns a compressed response containing all available component types."
},
{
"info": {
"name": "Get Config",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/config",
"auth": {
"type": "oauth2",
"flow": "resource_owner_password_credentials",
"accessTokenUrl": "api/v1/login",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieve application configuration settings.
Returns different configuration based on authentication status:
- Authenticated users: Full ConfigResponse with all settings
- Unauthenticated users: PublicConfigResponse with limited, safe-to-expose settings
Args:
user: The authenticated user, or None if unauthenticated.
Returns:
ConfigResponse | PublicConfigResponse: Configuration settings appropriate for the user's auth status.
Raises:
HTTPExce"
},
{
"info": {
"name": "Experimental Run Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/api/v1/run/advanced/:flow_id_or_name",
"params": [
{
"name": "flow_id_or_name",
"value": "",
"type": "path"
},
{
"name": "user_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-key",
"value": "{{x-api-key}}",
"placement": "query"
}
},
"docs": "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 provid"
},
{
"info": {
"name": "Simplified Run Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/api/v1/run/:flow_id_or_name",
"params": [
{
"name": "flow_id_or_name",
"value": "",
"type": "path"
},
{
"name": "stream",
"value": "",
"type": "query"
},
{
"name": "user_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-key",
"value": "{{x-api-key}}",
"placement": "query"
}
},
"docs": "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 "
},
{
"info": {
"name": "Get Version",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/version"
},
"docs": "Get Version"
},
{
"info": {
"name": "Webhook Run Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/api/v1/webhook/:flow_id_or_name",
"params": [
{
"name": "flow_id_or_name",
"value": "",
"type": "path"
},
{
"name": "user_id",
"value": "",
"type": "query"
}
]
},
"docs": "Run a flow using a webhook request.
Args:
flow_id_or_name: The flow ID or endpoint name (used by dependency).
flow: The flow to be executed.
request: The incoming HTTP request.
Returns:
A dictionary containing the status of the task.
Raises:
HTTPException: If the flow is not found or if there is an error processing the request."
}
]
}
],
"bundled": true
}