---
title: "Liveness probe"
method: GET
path: "/api/v1/health"
tags: ["Service"]
---

# Liveness probe

`GET /api/v1/health`

## Request

- Base URL: `https://beyourcover.com`
- URL: `https://beyourcover.com/api/v1/health`
- Auth: none required

Public liveness check — the only endpoint that needs no API key. Reports that the API is serving requests; it does not check downstream dependencies (database, payment, or image providers), so a `200` here does not promise that a generation will succeed. Per-operation availability is reported by `GET /api/v1/capabilities`. This is the `status` target of the RFC 9727 API catalog at `/.well-known/api-catalog`. Responses are not cached.

## Response `200`

API is serving requests.

- Health
  - `status` 'ok', required: Always `ok` when the API responds. Unreachability is signalled by the transport (connection failure or a 5xx), not by this field.
  - `service` string, required: Service name, matching `info.title` in the OpenAPI spec.
  - `version` string, required: API contract version, matching `info.version` in the OpenAPI spec.

---

[API](https://skmtc.dev/beyourcover/apis/beyourcover-partner-api.md) · [All operations](https://skmtc.dev/beyourcover/apis/beyourcover-partner-api/llms.txt) · [OpenAPI document](https://skmtc.dev/beyourcover/apis/beyourcover-partner-api/revisions/82ad2c7c8ede?raw)