Health

Check that the API and its RAGFlow backend are reachable.

Method	Path
GET	/api/v1/health

Health

GET /api/v1/health

Liveness of vol-api and reachability of RAGFlow.

From the API schema: Public. Reports whether RAGFlow is reachable. Cached for 30 s.

Auth: Public — no credentials

cURL

curl "https://vol.example.com/api/v1/health"

TypeScript

import { VolClient } from "@vol/sdk";

const vol = new VolClient({ baseUrl: "https://vol.example.com/api" });
await vol.health();

Python

import os, requests

r = requests.get(
    "https://vol.example.com/api/v1/health",
    timeout=60,
)
r.raise_for_status()
print(r.json())

Response 200

{
  "status": "ok",
  "ragflow": true,
  "version": "1.0.0"
}