> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shinzo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Health Check

> Verify connectivity and health of the Shinzo Platform API.

# Health Check

Check the health status of the Shinzo Platform API. These endpoints do not require authentication and can be used to verify connectivity.

## Basic Health Check

Fast health check endpoint with cached database status.

### Endpoint

```
GET /health
```

### Authentication

No authentication required.

### Example Request

```bash theme={null}
curl -X GET https://api.app.shinzo.ai/health
```

### Response

```json theme={null}
{
  "status": "healthy",
  "database": "healthy"
}
```

### Status Codes

| Code  | Description          |
| ----- | -------------------- |
| `200` | Service is healthy   |
| `503` | Service is unhealthy |

***

## Deep Health Check

Comprehensive health check that queries the database and reports latency metrics.

### Endpoint

```
GET /health/deep
```

### Authentication

No authentication required.

### Example Request

```bash theme={null}
curl -X GET https://api.app.shinzo.ai/health/deep
```

### Response

```json theme={null}
{
  "status": "healthy",
  "database": {
    "status": "healthy",
    "latency_ms": 5
  },
  "timestamp": "2025-01-20T14:30:00Z"
}
```

### Response Fields

| Field                 | Type   | Description                                                |
| --------------------- | ------ | ---------------------------------------------------------- |
| `status`              | string | Overall health status (`healthy`, `degraded`, `unhealthy`) |
| `database.status`     | string | Database connection status                                 |
| `database.latency_ms` | number | Database query latency in milliseconds                     |
| `timestamp`           | string | Health check timestamp (ISO 8601)                          |

### Status Codes

| Code  | Description          |
| ----- | -------------------- |
| `200` | Service is healthy   |
| `503` | Service is unhealthy |

## Use Cases

* **Load balancer health checks**: Use `/health` for fast checks
* **Monitoring and alerting**: Use `/health/deep` for detailed status
* **Connectivity verification**: Use either endpoint to verify API reachability