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

# Health Check

> Public service health check — no API key required

## Overview

Public endpoint used by Railway for container health checks and uptime monitors.
Returns service status, version, and environment. No authentication required.

**Tier:** Public ✅ — No API key required
**Cache:** None

## Aliases

The health check is available at multiple paths for convenience:

| Path                  | Purpose                                                     |
| --------------------- | ----------------------------------------------------------- |
| `GET /v1/health`      | Primary health endpoint                                     |
| `GET /v1/health/live` | Railway liveness probe (same response, not in OpenAPI spec) |

## Response Fields

| Field         | Type   | Description                      |
| ------------- | ------ | -------------------------------- |
| `status`      | string | Always `"ok"` when healthy       |
| `version`     | string | Current API version              |
| `environment` | string | Deployment environment           |
| `timestamp`   | string | Current UTC timestamp (ISO 8601) |

<RequestExample>
  ```bash curl theme={null}
  curl https://api.aioka.io/v1/health
  ```

  ```python Python theme={null}
  import httpx

  resp = httpx.get("https://api.aioka.io/v1/health")
  print(resp.json())
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "ok",
    "version": "1.0.0",
    "environment": "production",
    "timestamp": "2026-04-03T10:22:00Z"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /v1/health
openapi: 3.1.0
info:
  title: AIOKA Intelligence API
  description: |

    ## AI-powered crypto market intelligence

    AIOKA Intelligence API provides real-time access to our AI Council verdicts,
    market signals, regime detection, and Ghost Trader entry signals.

    ### Tiers
    - **Free**: 100 calls/day — Verdict + Regime
    - **Basic** ($49/mo): 1,000 calls/day — + Signals
    - **Pro** ($199/mo): 10,000 calls/day — + Council + Ghost

    ### Authentication
    Pass your API key in the `X-API-Key` header:

    ```
    X-API-Key: aik_free_xxxxxxxxxxxx
    ```

    ### Get your API key
    `POST /v1/keys/generate` (free tier, no credit card)
  contact:
    name: AIOKA Support
    url: https://docs.aioka.io/
    email: api@aioka.io
  license:
    name: Commercial
    url: https://aioka.io/terms
  version: 1.0.0
servers:
  - url: https://api.aioka.io
    description: Production — AIOKA Intelligence API
security: []
paths:
  /v1/health:
    head:
      tags:
        - Health
      summary: Health Check
      description: |-
        Returns service status. No API key required.

        **Tier:** Public ✅
        **Cache:** None
        **Use:** Railway health checks, uptime monitors
      operationId: health_check_v1_health_get
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      security: []
components:
  schemas:
    HealthResponse:
      properties:
        status:
          type: string
          title: Status
        version:
          type: string
          title: Version
        environment:
          type: string
          title: Environment
        timestamp:
          type: string
          format: date-time
          title: Timestamp
      type: object
      required:
        - status
        - version
        - environment
        - timestamp
      title: HealthResponse
      example:
        environment: production
        status: ok
        timestamp: '2026-04-03T10:22:00Z'
        version: 1.0.0

````