NoteBugsDocs

API reference

System

Health and version.

/api/health is used by the Compose healthcheck and is the only route outside /api/auth that answers with no credential.

GET/api/health
Role: none

The healthcheck: the application is up and the database answers.

Request

curl -s http://localhost:3000/api/health

Response200

{ "status": "ok", "db": "up" }

It is the only route outside /api/auth that answers with no credential: the Compose healthcheck has no credential to present.

GET/api/version
Role: Viewer

Version, build id, when it was compiled and when the process came up.

Request

curl -s http://localhost:3000/api/version \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "version": "1.0.0",
  "buildId": "83e365e17fb0",
  "builtAt": "2026-09-01T01:46:05.578Z",
  "startedAt": "2026-09-09T00:57:40.514Z"
}

Error responses

CodeWhen it happens
401No credential, or one that no longer holds. Send the session cookie or the Authorization: Bearer header.