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

# Health

> Check if the API is running



## OpenAPI

````yaml get /api/v2/health
openapi: 3.0.0
info:
  title: AquilaX AI API Docs
  version: '2.0'
  description: >
    Welcome to the API documentation for AquilaX. Integrate AquilaX for advanced
    data processing and analytics in your applications. Key features include
    seamless data ingestion, powerful processing capabilities, analytics tools,
    real-time updates, and robust security measures. Get started with API keys,
    explore endpoints, understand formats, and implement error
    handling.Authorization is required for all end-points, excluding the one
    under Public Section. To authenticate, a Personal Access Token `PAT` must be
    included in the request header with the name `X-AX-KEY`. Happy coding!
servers:
  - url: https://aquilax.ai
    description: Cloud Instance
security:
  - ApiKeyAuth: []
tags:
  - name: Health
    description: Endpoints for metrics and health check
  - name: Profile
    description: Endpoints for managing user profiles
  - name: Public Scan
    description: Endpoints for scanning a public git repo
  - name: Admin
    description: Endpoints for AquilaX Worker
paths:
  /api/v2/health:
    get:
      tags:
        - Health
      summary: Health
      description: Check if the API is running
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      description: Schema for health check response.
      properties:
        ID:
          type: string
          example: 95148e14be674e067be644de814de36c
          description: random generated request id
        hostname:
          type: string
          example: localhost
          description: Hostname of the server
        status:
          type: string
          example: ok
          description: ' `ok` only if the API Services is healthy'
        timestamp:
          type: integer
          example: 1741492261
          description: unix timestamp of the request
        version:
          type: integer
          example: 2
          description: API Version
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-AX-KEY

````