Check sidecar health

GET/api/status

Reports whether each extraction sidecar answers. Returns 200 when every configured sidecar is up and 503 when one is down or degraded, so a plain HTTP monitor can watch it. A sidecar you never configured counts as healthy. Results are cached for 5 seconds.

See Monitoring.

Response

200 · application/json

Every configured sidecar is up.

okboolean

false when any configured sidecar is down. Matches the HTTP status: 200 or 503.

versionstring

PullMD version.

servicesobject

One entry per sidecar. Results are cached for 5 seconds.

errorstring

check-failed when the status check itself failed. services is empty then.

cURLcURLPythonJavaScript

curl --request GET \
  --url 'http://localhost:3000/api/status'

{
  "ok": true,
  "version": "3.18.2",
  "services": {
    "trafilatura": {
      "status": "ok",
      "latencyMs": 7
    },
    "playwright": {
      "status": "ok",
      "latencyMs": 67
    },
    "markitdown": {
      "status": "ok",
      "latencyMs": 8
    }
  }
}