---
title: "Shallow + deep health check"
method: GET
path: "/v1/health"
tags: ["health"]
---

# Shallow + deep health check

`GET /v1/health`

## Request

- Base URL: `https://api.cueframe.ai`
- URL: `https://api.cueframe.ai/v1/health`
- Auth: none required

Shallow (default) returns 200 with a minimal liveness payload for load balancers. Append `?deep=1` to exercise component bindings (rate-limiter). Unauthenticated.

## Query parameters

- `deep` '1'

## Response `200`

Healthy (or `?deep=1` checks pass).

- HealthResponse: Health probe response.
  - `status` 'ok' | 'degraded', required
  - `version` string, required
  - `checks` object

## Other responses

- `400`: Bad request — validation_error / invalid_cursor / invalid_query.
- `503`: Service unavailable — billing_unavailable / honest-503 for runtime deps.

---

[API](https://skmtc.dev/cueframe/apis/cueframe-api.md) · [All operations](https://skmtc.dev/cueframe/apis/cueframe-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cueframe/apis/cueframe-api/revisions/8f9bfe362b4a?raw)