---
title: "Health"
method: GET
path: "/api/v2/health"
tags: ["Health"]
---

# Health

`GET /api/v2/health`

## Request

- Base URL: `https://aquilax.ai`
- URL: `https://aquilax.ai/api/v2/health`
- Auth: none required
- TypeScript: <https://skmtc.dev/aquilax-ai/apis/aquilax-ai-api-docs/docs/api/v2/health/get.ts> (a function with typed inputs; its response is checked against the schema)

Check if the API is running

## Response `200`

Service is healthy

- HealthResponse: Schema for health check response.
  - `ID` string: random generated request id
  - `hostname` string: Hostname of the server
  - `status` string: `ok` only if the API Services is healthy
  - `timestamp` integer: unix timestamp of the request
  - `version` integer: API Version

---

[API](https://skmtc.dev/aquilax-ai/apis/aquilax-ai-api-docs.md) - [All operations](https://skmtc.dev/aquilax-ai/apis/aquilax-ai-api-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/aquilax-ai/apis/aquilax-ai-api-docs/revisions/9b4f595ad674?raw)