API reference
GET /healthz
Liveness and readiness probe used by the platform health checker and external uptime monitors.
Public, unauthenticated probe. Returns a compact JSON document and a 2xx status when the worker is ready to accept work. Used by the platform health checker and by our internal uptime monitor.
Endpoint
GET https://api.prom.codes/healthz
No headers required.
Response
{
"status": "ok",
"version": "1.4.2"
}The body is intentionally minimal — a status and the deployed service version. Anything beyond "is it up" (per-check detail, uptime, memory) stays on our internal monitoring, not on a public endpoint.
Status semantics
| HTTP | Body ok | Meaning |
|---|---|---|
| 200 | true | All dependencies reachable. |
| 200 | false | Worker is up but degraded. Detail in checks. Treated as healthy by the platform. |
| 503 | false | Worker is starting up or in shutdown. Treated as unhealthy. |
The checks block reports the last successful probe of each
dependency. Probes run every 30 s in the background, so values are
near-realtime but not strictly per-request — the endpoint itself
is intentionally side-effect free.
Related
POST /index— the actual work endpoint.MCP tools— the stdio surface used by agent hosts.