pengjunjie/langflow
1
0
Fork 1
mirror of https://github.com/langflow-ai/langflow.git synced 2026-07-25 10:06:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: health_check API reference (#10134)

Browse Source 
* docs-api-reference-health-check-add-pragma

* remove-pragma-flag
This commit is contained in:
Mendon Kissling
2025-10-07 10:05:14 -04:00
committed by GitHub
parent e06544cd74
commit eb7359c64b
1 changed files with 42 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/docs/API-Reference/api-reference-api-examples.mdx
View File

@ -122,6 +122,32 @@ You can retrieve flow IDs from the [**API access** pane](/concepts-publish#api-a
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:
```bash
curl -X GET \
"$LANGFLOW_SERVER_URL/health_check" \
-H "accept: application/json"
```
<details>
<summary>Result</summary>
```json
{
"status": "ok",
"chat": "ok",
"db": "ok"
}
```
</details>
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:
@ -130,7 +156,6 @@ Returns the current Langflow API version:
curl -X GET \
"$LANGFLOW_SERVER_URL/api/v1/version" \
-H "accept: application/json"
-H "x-api-key: $LANGFLOW_API_KEY"
```
<details>
@ -138,8 +163,8 @@ curl -X GET \
```text
{
"version": "1.1.1",
"main_version": "1.1.1",
"version": "1.6.0",
"main_version": "1.6.0",
"package": "Langflow"
}
```
@ -154,7 +179,6 @@ Returns configuration details for your Langflow deployment:
curl -X GET \
"$LANGFLOW_SERVER_URL/api/v1/config" \
-H "accept: application/json"
-H "x-api-key: $LANGFLOW_API_KEY"
```
<details>
@ -165,11 +189,21 @@ curl -X GET \
"feature_flags": {
"mvp_components": false
},
"serialization_max_items_length": 1000,
"serialization_max_text_length": 6000,
"frontend_timeout": 0,
"auto_saving": true,
"auto_saving_interval": 1000,
"health_check_max_retries": 5,
"max_file_size_upload": 1024
"max_file_size_upload": 1024,
"webhook_polling_interval": 5000,
"public_flow_cleanup_interval": 3600,
"public_flow_expiration": 86400,
"event_delivery": "streaming",
"webhook_auth_enable": false,
"voice_mode_available": false,
"default_folder_name": "Starter Project",
"hide_getting_started_progress": false
}
```
@ -177,7 +211,8 @@ curl -X GET \
### Get all components
Returns a dictionary of all Langflow components:
Returns a dictionary of all Langflow components.
Requires a [Langflow API key](/api-keys-and-authentication).
```bash
curl -X GET \
@ -215,6 +250,7 @@ Other endpoints are helpful for specific use cases, such as administration and f
* Deployment details:
* GET `/v1/version`: Return Langflow version. See [Get version](/api-reference-api-examples#get-version).
* GET `/v1/config`: Return deployment configuration. See [Get configuration](/api-reference-api-examples#get-configuration).
* GET `/health_check`: Health check endpoint that validates database and chat service connectivity. Returns 500 status if any service is unavailable.
* [Projects endpoints](/api-projects):
* POST `/v1/projects/`: Create a project.