---
title: Health
description: Generated HTTP reference for the 1 operation the published OpenAPI document describes under health.
---

# Health

This page is generated from the published OpenAPI document. It is complete with respect to that document and says nothing about surfaces the document does not describe yet. See [what is generated here](/docs/api/reference) for what that means.

Base URL: `https://api.codespar.dev`

Every operation below requires a Bearer token. See [Authentication](/docs/concepts/authentication).

### GET `/v1/health`

Read graded dependency health, as this credential's tenant sees it

**Responses**

| Status | Body | Description |
|---|---|---|
| `200` | object | OK |

**Response `200`**

| Field | Type | Required | Description |
|---|---|---|---|
| `checks` | object | yes | — |
| `observed_at` | `string (date-time)` | yes | When this call built the response. It is also the snapshot key, so two calls landing in the same instant store one row. |
| `schema_version` | object | yes | — |
| `status` | `"healthy"` \| `"degraded"` \| `"down"` | yes | `down` iff the database or the vault check failed. `degraded` iff embeddings are empty, FX is not fresh, telemetry is stale, or the tenant has no connection. `healthy` otherwise — which includes embeddings `low`, connections `partial` and telemetry `idle`. |

**Example response**

```json
{
  "status": "healthy",
  "checks": {
    "db": {
      "ok": true,
      "message": "string",
      "latency_ms": 0
    },
    "vault": {
      "ok": true,
      "message": "string"
    },
    "embeddings": {
      "populated": 0,
      "total": 0,
      "percent": 0,
      "status": "ok",
      "message": "string"
    },
    "fx_rates": {
      "status": "fresh",
      "message": "string"
    },
    "telemetry": {
      "last_hour_attempts": 0,
      "last_24h_attempts": 0,
      "status": "active",
      "message": "string"
    },
    "connections": {
      "connected": 0,
      "total_servers": 0,
      "status": "wired",
      "message": "string"
    }
  },
  "schema_version": {
    "latest": "string"
  },
  "observed_at": "2026-01-15T12:00:00.000Z"
}
```

**Example request**

```bash
curl -X GET https://api.codespar.dev/v1/health \
  -H "Authorization: Bearer $CODESPAR_API_KEY"
```