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

# Health

## Health Check

> General health check endpoint.\
> \
> Returns basic health status. For infrastructure monitoring,\
> use /health/readiness or /health/liveness instead.

```json
{"openapi":"3.1.0","info":{"title":"otari","version":"0.33.0"},"paths":{"/api/v1/health":{"get":{"description":"General health check endpoint.\n\nReturns basic health status. For infrastructure monitoring,\nuse /health/readiness or /health/liveness instead.","operationId":"health-health_check","responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"title":"Response Health-Health Check","type":"object"}}},"description":"Successful Response"}},"summary":"Health Check","tags":["health"]}}}}
```

## Health Liveness

> Liveness probe endpoint.\
> \
> Simple check to verify the process is alive and responding.\
> Used by Kubernetes/container orchestrators for liveness probes.\
> \
> Returns:\
>     Plain text "I'm alive!" message

```json
{"openapi":"3.1.0","info":{"title":"otari","version":"0.33.0"},"paths":{"/api/v1/health/liveness":{"get":{"description":"Liveness probe endpoint.\n\nSimple check to verify the process is alive and responding.\nUsed by Kubernetes/container orchestrators for liveness probes.\n\nReturns:\n    Plain text \"I'm alive!\" message","operationId":"health-health_liveness","responses":{"200":{"content":{"application/json":{"schema":{"title":"Response Health-Health Liveness","type":"string"}}},"description":"Successful Response"}},"summary":"Health Liveness","tags":["health"]}}}}
```

## Health Readiness

> Readiness probe endpoint.\
> \
> Checks if the gateway is ready to serve requests by validating:\
> \- Database connectivity\
> \- Service availability\
> \
> Used by Kubernetes/container orchestrators for readiness probes.\
> Returns HTTP 503 if any dependency is unavailable.\
> \
> Returns:\
>     dict: Status object with health details\
> \
> Raises:\
>     HTTPException: 503 if service is not ready

```json
{"openapi":"3.1.0","info":{"title":"otari","version":"0.33.0"},"paths":{"/api/v1/health/readiness":{"get":{"description":"Readiness probe endpoint.\n\nChecks if the gateway is ready to serve requests by validating:\n- Database connectivity\n- Service availability\n\nUsed by Kubernetes/container orchestrators for readiness probes.\nReturns HTTP 503 if any dependency is unavailable.\n\nReturns:\n    dict: Status object with health details\n\nRaises:\n    HTTPException: 503 if service is not ready","operationId":"health-health_readiness","responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":true,"title":"Response Health-Health Readiness","type":"object"}}},"description":"Successful Response"}},"summary":"Health Readiness","tags":["health"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.otari.ai/api-reference/health.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.