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

# GET / Health Check — Verify the Service Is Running

> The GET / endpoint returns a fixed JSON status payload confirming your RAG PDF Highlighter instance is live and ready to accept highlight requests.

The health check endpoint lets you confirm that your RAG PDF Highlighter instance is up and accepting connections. It requires no request body and returns a fixed JSON payload indicating the service is operational. Use it in load balancer health checks, container orchestration liveness probes, or your own uptime monitoring scripts.

## Request

**Method:** `GET`\
**Path:** `/`\
**Parameters:** none\
**Request body:** none

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

## Response

### 200 OK

The service is running and ready to accept requests.

```json theme={null}
{"status": "ok the app is running"}
```

<ResponseField name="status" type="string">
  Always `"ok the app is running"` when the service is healthy. This value is fixed — you can use an exact string match to determine liveness.
</ResponseField>

## Use Cases

**Container liveness probes** — Kubernetes and other orchestrators can hit `GET /` on a configurable interval. A 200 response means the container is alive; any non-200 response or connection failure triggers a restart.

**Load balancer health checks** — Configure your load balancer to poll `GET /` and remove the instance from the pool if it stops responding.

**Smoke testing after deployment** — After deploying a new version of the service, call `GET /` before routing production traffic to verify the instance started correctly.