---
title: "Cheap process liveness and initialization."
method: GET
path: "/api/health"
tags: ["Catalog"]
---

# Cheap process liveness and initialization.

`GET /api/health`

## Request

- Base URL: `https://huggingbay.xyz`
- URL: `https://huggingbay.xyz/api/health`
- Auth: none declared

Memory-only process health, independent of database and admin load. ready means process initialization only. Require /api/readiness for dependency checks and mutation preflights.

**Inputs.** Path, query and header fields are listed below. No request body is required.

**Outputs.** See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.

**Errors.** API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.

**Rate limits.** Public read budgets apply by client IP and route group. This operation can have a smaller route-specific budget. Read Retry-After on 429 or retryable 503 responses.

## Query parameters

- `compat` 'containment'

## Response `200`

Process initialized and not shutting down

- ProcessHealth
  - `schemaVersion` 'hugging-bay.health.v1', required
  - `ok` boolean, required
  - `ready` boolean, required
  - `liveness` 'ok' | 'stopping', required
  - `service` 'hugging-bay', required
  - `probe` 'liveness'
  - `livenessOnly` unknown
  - `readinessScope` 'process-initialization', required
  - `readinessAuthority` '/api/readiness'
  - `dependencyReadiness` '/api/readiness', required
  - `note` string: Liveness-only disclaimer: ok/200 do not imply readiness; poll /api/readiness (503 while unready).

## Other responses

- `503`: Process initializing or shutting down

---

[API](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api.md) · [All operations](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api/revisions/ea7ba26b1e27?raw)