---
title: "Strict service readiness."
method: GET
path: "/api/readiness"
tags: ["Catalog"]
---

# Strict service readiness.

`GET /api/readiness`

## Request

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

Operator-facing hugging-bay.health.v1 readiness. Returns 503 unless dependencies, representative reads, and verified downloads are ready.

**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`

Ready

- Health
  - `schemaVersion` 'hugging-bay.health.v1', required
  - `ok` boolean, required
  - `ready` boolean, required
  - `degraded` boolean
  - `reason` string
  - `liveness` 'ok', required
  - `service` 'hugging-bay', required
  - `verifiedDownloads` object, required
    - `ready` boolean, required
    - `severity` string

## Other responses

- `503`: Not ready

---

[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/865eb0f1b6ef?raw)