> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/kyutai-labs/unmute/llms.txt
> Use this file to discover all available pages before exploring further.

# Health Check

> Monitor the status of Unmute backend services

## Overview

The health check endpoint allows you to verify that all required Unmute backend services are operational. This endpoint checks the status of the TTS (Text-to-Speech), STT (Speech-to-Text), LLM (Language Model), and Voice Cloning services.

## Endpoint

<CodeGroup>
  ```bash GET /v1/health theme={null}
  curl https://api.unmute.example/v1/health
  ```
</CodeGroup>

## Response

The endpoint returns a JSON object with the status of each service:

<ResponseField name="tts_up" type="boolean" required>
  Indicates whether the Text-to-Speech service is operational
</ResponseField>

<ResponseField name="stt_up" type="boolean" required>
  Indicates whether the Speech-to-Text service is operational
</ResponseField>

<ResponseField name="llm_up" type="boolean" required>
  Indicates whether the Language Model service is operational
</ResponseField>

<ResponseField name="voice_cloning_up" type="boolean" required>
  Indicates whether the Voice Cloning service is operational
</ResponseField>

<ResponseField name="ok" type="boolean" required>
  Overall health status. Returns `true` if TTS, STT, and LLM services are all operational. Note that voice cloning is not required for the server to be considered healthy.
</ResponseField>

## Response Example

```json theme={null}
{
  "tts_up": true,
  "stt_up": true,
  "llm_up": true,
  "voice_cloning_up": true,
  "ok": true
}
```

## Error Response

If any critical service is down, the response will indicate which services are unavailable:

```json theme={null}
{
  "tts_up": true,
  "stt_up": false,
  "llm_up": true,
  "voice_cloning_up": false,
  "ok": false
}
```

## Status Codes

<ResponseField name="200" type="status code">
  Successfully retrieved health status (returned regardless of whether services are healthy or not)
</ResponseField>

## Caching

This endpoint implements a 0.5-second TTL cache to prevent excessive health checks from overwhelming the backend services.

## Usage Notes

* The `ok` field only considers TTS, STT, and LLM services as critical
* Voice cloning service status is informational but does not affect the overall `ok` status
* Health checks are performed asynchronously in parallel for optimal performance
* This endpoint should be called before initiating a WebSocket connection to `/v1/realtime`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.