diff --git a/404.html b/404.html index d1a8dde2bd..f2db570a4b 100644 --- a/404.html +++ b/404.html @@ -23,7 +23,7 @@ - + diff --git a/agent-tutorial.html b/agent-tutorial.html index 0799920e07..32839ec741 100644 --- a/agent-tutorial.html +++ b/agent-tutorial.html @@ -23,7 +23,7 @@ - + diff --git a/agents-tools.html b/agents-tools.html index d8eb075b5f..b5bb382687 100644 --- a/agents-tools.html +++ b/agents-tools.html @@ -23,7 +23,7 @@ - + diff --git a/agents.html b/agents.html index 4fa0c62256..f47a483788 100644 --- a/agents.html +++ b/agents.html @@ -23,7 +23,7 @@ - + diff --git a/api-build.html b/api-build.html index a1b66f6bfa..4ae51c49a8 100644 --- a/api-build.html +++ b/api-build.html @@ -23,7 +23,7 @@ - + diff --git a/api-files.html b/api-files.html index dfb4647e2b..e730fdc7c9 100644 --- a/api-files.html +++ b/api-files.html @@ -23,7 +23,7 @@ - + diff --git a/api-flows-run.html b/api-flows-run.html index 454a11bc0e..51bc12dfdb 100644 --- a/api-flows-run.html +++ b/api-flows-run.html @@ -23,7 +23,7 @@ - + diff --git a/api-flows.html b/api-flows.html index dd0955ee3c..2c6d54dbeb 100644 --- a/api-flows.html +++ b/api-flows.html @@ -23,7 +23,7 @@ - + diff --git a/api-keys-and-authentication.html b/api-keys-and-authentication.html index a73adf41dd..7742a4233d 100644 --- a/api-keys-and-authentication.html +++ b/api-keys-and-authentication.html @@ -23,7 +23,7 @@ - + diff --git a/api-logs.html b/api-logs.html index a8b028b7f4..6016a3ad40 100644 --- a/api-logs.html +++ b/api-logs.html @@ -23,7 +23,7 @@ - + diff --git a/api-monitor.html b/api-monitor.html index 2e1340ebfc..0c438a923d 100644 --- a/api-monitor.html +++ b/api-monitor.html @@ -23,7 +23,7 @@ - + diff --git a/api-openai-responses.html b/api-openai-responses.html index 8c7417fcb8..8a3a3750b6 100644 --- a/api-openai-responses.html +++ b/api-openai-responses.html @@ -23,7 +23,7 @@ - + diff --git a/api-projects.html b/api-projects.html index ef64000137..d3f0fead37 100644 --- a/api-projects.html +++ b/api-projects.html @@ -23,7 +23,7 @@ - + diff --git a/api-reference-api-examples.html b/api-reference-api-examples.html index 7bdcd30714..5ec41558d3 100644 --- a/api-reference-api-examples.html +++ b/api-reference-api-examples.html @@ -23,7 +23,7 @@ - + @@ -96,16 +96,23 @@ For example:

You can retrieve flow IDs from the API access pane, in a flow's URL, and with GET /flows.

Try some Langflow API requests​

Once you have your Langflow server URL, try calling these endpoints that return Langflow metadata.

+

Health check​

+

Returns the health status of the Langflow database and chat services:

+

_10
curl -X GET \
_10
"$LANGFLOW_SERVER_URL/health_check" \
_10
-H "accept: application/json"

+
Result

_10
{
_10
"status": "ok",
_10
"chat": "ok",
_10
"db": "ok"
_10
}

+

Langflow provides an additional GET /health endpoint. +This endpoint is served by uvicorn before Langflow is fully initialized, so it's not reliable for checking Langflow service health.

Get version​

Returns the current Langflow API version:

-

_10
curl -X GET \
_10
"$LANGFLOW_SERVER_URL/api/v1/version" \
_10
-H "accept: application/json"
_10
-H "x-api-key: $LANGFLOW_API_KEY"

-
Result

_10
{
_10
"version": "1.1.1",
_10
"main_version": "1.1.1",
_10
"package": "Langflow"
_10
}

+

_10
curl -X GET \
_10
"$LANGFLOW_SERVER_URL/api/v1/version" \
_10
-H "accept: application/json"

+
Result

_10
{
_10
"version": "1.6.0",
_10
"main_version": "1.6.0",
_10
"package": "Langflow"
_10
}

Get configuration​

Returns configuration details for your Langflow deployment:

-

_10
curl -X GET \
_10
"$LANGFLOW_SERVER_URL/api/v1/config" \
_10
-H "accept: application/json"
_10
-H "x-api-key: $LANGFLOW_API_KEY"

-
Result

_10
{
_10
"feature_flags": {
_10
"mvp_components": false
_10
},
_10
"frontend_timeout": 0,
_10
"auto_saving": true,
_10
"auto_saving_interval": 1000,
_10
"health_check_max_retries": 5,
_10
"max_file_size_upload": 1024
_10
}

+

_10
curl -X GET \
_10
"$LANGFLOW_SERVER_URL/api/v1/config" \
_10
-H "accept: application/json"

+
Result

_20
{
_20
"feature_flags": {
_20
"mvp_components": false
_20
},
_20
"serialization_max_items_length": 1000,
_20
"serialization_max_text_length": 6000,
_20
"frontend_timeout": 0,
_20
"auto_saving": true,
_20
"auto_saving_interval": 1000,
_20
"health_check_max_retries": 5,
_20
"max_file_size_upload": 1024,
_20
"webhook_polling_interval": 5000,
_20
"public_flow_cleanup_interval": 3600,
_20
"public_flow_expiration": 86400,
_20
"event_delivery": "streaming",
_20
"webhook_auth_enable": false,
_20
"voice_mode_available": false,
_20
"default_folder_name": "Starter Project",
_20
"hide_getting_started_progress": false
_20
}

Get all components​

-

Returns a dictionary of all Langflow components:

+

Returns a dictionary of all Langflow components. +Requires a Langflow API key.


_10
curl -X GET \
_10
"$LANGFLOW_SERVER_URL/api/v1/all" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $LANGFLOW_API_KEY"

Available endpoints​

Because you can run Langflow as either an IDE (frontend and backend) or a runtime (headless, backend-only), it serves endpoints that support frontend and backend operations. @@ -136,6 +143,7 @@ Other endpoints are helpful for specific use cases, such as administration and f

  • @@ -336,7 +344,7 @@ They aren't typically called directly; instead, they are used to drive inte
  • Use the Langflow API to upload files.
  • Use the Langflow API to get flow logs.
  • Explore all endpoints in the Langflow API specification.
    • -