Health check

The unauthenticated liveness probe: check whether the API and its dependencies are up.

GET/v1/health

The liveness probe, and the only unauthenticated route (no key, no scope), so a load balancer, uptime monitor, or status page can poll it freely. Returns 200 when the API and its dependencies are healthy, or 503 when a dependency is degraded. Unlike the rest of the API, this endpoint does not use the standard envelope: it's a flat, monitor-friendly body.

No key required

/health is the one route that takes no Authorization header. You can leave the key field blank in the explorer below.

Try it, for realGET /health

Test keys only. Never paste a live key. Your key is stored only in this browser (localStorage) and sent only to the same-origin playground proxy.

›Equivalent request (curl / TypeScript)
curl
curl -X GET https://sandbox.api.acute.network/v1/health \
  -H "Authorization: Bearer acuinf_test_…"
TypeScript
const res = await fetch("https://sandbox.api.acute.network/v1/health", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.ACUTE_TEST_KEY}`,
  },
});
const { data, meta } = await res.json();

curl https://api.acute.network/v1/health
{
  "success": true,
  "message": "Operational",
  "version": "1.0.0",
  "uptime": "4213.07 seconds",
  "timestamp": "2026-06-24T11:02:44.901Z",
  "services": { "database": "ok" }
}

Branch on the status code

Treat 200 as up and 503 as degraded. The body's success mirrors the status, and services tells you which dependency is the problem, but for a simple health gate, the HTTP status is all you need.

successbooleanrequired

true when healthy (200), false when degraded (503).

messagestringrequired

"Operational" when healthy, "Degraded" otherwise.

versionstringrequired

The running API version.

uptimestringrequired

Process uptime, e.g. "4213.07 seconds".

timestampstringrequired

ISO-8601 timestamp of the check.

services{ database: string }required

Per-dependency status. database is "ok" when reachable, or "error: <reason>" when not.