> For the complete documentation index, see [llms.txt](https://docs.digitalhumans.jp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digitalhumans.jp/dev/miniprem/api/health.md).

# Renny ヘルス API

{% hint style="info" %}
本ページの内容はデジタルヒューマン株式会社の正式サポート対象外です。参考情報としてご利用ください。
{% endhint %}

{% hint style="info" %}
**ヘルスモニタリング:** Renny サービスの稼働状態と接続のヘルスをモニタリングし、運用上の可視性を確保します。
{% endhint %}

## ベース URL

```
http://localhost:8081
```

***

## ヘルスエンドポイント

Renny サービス全体のヘルス状態を確認します。

### エンドポイント

```
GET /health
```

### レスポンス

```json
{
  "status": "ok",
  "version": "5.6mha",
  "connections": {
    "internal_speech": "enabled",
    "uneeq": "connected",
    "azure_speech": "fallback_available"
  }
}
```

| フィールド                         | 説明                          |
| ----------------------------- | --------------------------- |
| `status`                      | サービス全体の状態（`ok` または `error`） |
| `version`                     | Renny サービスのバージョン            |
| `connections.internal_speech` | 内部 STT（音声認識）の状態             |
| `connections.uneeq`           | デジタルヒューマン プラットフォームとの接続状態    |
| `connections.azure_speech`    | Azure TTS（音声合成）フォールバックの状態   |

### 実行例

```bash
curl http://localhost:8081/health
```

***

## ユースケース

### Kubernetes Liveness Probe

```yaml
livenessProbe:
  httpGet:
    path: /health
    port: 8081
  initialDelaySeconds: 30
  periodSeconds: 10
```

### Docker ヘルスチェック

```yaml
healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost:8081/health"]
  interval: 30s
  timeout: 10s
  retries: 3
```

### モニタリングスクリプト

```bash
#!/bin/bash
response=$(curl -s http://localhost:8081/health)
status=$(echo $response | jq -r '.status')

if [ "$status" != "ok" ]; then
  echo "Renny health check failed"
  exit 1
fi
```

***

## 関連ドキュメント

[🛠Renny ガイド設定とセットアップガイドを表示 →](/dev/miniprem/services/renny.md)[📊モニタリングPrometheus と Grafana のセットアップガイドを表示 →](/dev/miniprem/services/monitoring.md)