> ## Documentation Index
> Fetch the complete documentation index at: https://freelance-4888ed08.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Health Check

> Verify API server liveness and model readiness for Docker and Kubernetes health probes

Verifies that the API server is running and has a production model loaded. **No authentication required.**

Use this endpoint for:

* **Liveness Probes** (Kubernetes/Docker `HEALTHCHECK`)
* **Startup Verification** (CI/CD pipelines)
* **Load Balancer Checks** (Nginx upstream health)

### Response

**status** `string` *required*

Always `"healthy"` when the server is operational.

**models\_loaded** `integer` *required*

Number of models currently loaded in memory (typically `1`).

**timestamp** `string` *required*

ISO 8601 formatted timestamp of the health check.

```bash cURL theme={null}
curl http://localhost:8000/health
```

```python Python theme={null}
import requests
response = requests.get("http://localhost:8000/health")
print(response.json())
```

```json 200 theme={null}
{
  "status": "healthy",
  "models_loaded": 1,
  "timestamp": "2025-01-15T14:30:00"
}
```


## OpenAPI

````yaml GET /health
openapi: 3.0.0
info:
  title: Demand Forecasting API
  version: 1.0.0
  description: API for retrieving demand forecasts and monitoring system health.
servers:
  - url: http://localhost:8000
    description: Local Model Server
security: []
paths:
  /health:
    get:
      summary: Health Check
      description: Returns the operational status of the model server.
      operationId: checkHealth
      responses:
        '200':
          description: Server is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: healthy
                  models_loaded:
                    type: integer
                    example: 1
                  timestamp:
                    type: string
                    format: date-time

````

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