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

# Liveness and readiness

> Reports process liveness and database reachability. Unauthenticated.



## OpenAPI

````yaml /openapi.json get /health
openapi: 3.1.0
info:
  title: tokz API
  version: 1.0.0
  description: >-
    Typed decisions about text from the open OpenDecision models. Text sent to
    /decide is read by the model and never stored or logged; only counters are
    kept. Fine tunes are built in the dashboard, which is not part of this API.
  contact:
    name: tokz
    url: https://tokz.dev
servers:
  - url: https://api.tokz.dev
    description: Production
  - url: http://127.0.0.1:3999
    description: Local dev (dev:pglite)
security:
  - bearerAuth: []
tags:
  - name: Decisions
    description: Typed decisions about text, answered by the OpenDecision models.
  - name: Fine tunes
    description: >-
      The files of a model you trained. Starting, canceling and deleting one
      happen in the dashboard.
  - name: Operations
    description: Health and diagnostics.
paths:
  /health:
    get:
      tags:
        - Operations
      summary: Liveness and readiness
      description: Reports process liveness and database reachability. Unauthenticated.
      operationId: health
      responses:
        '200':
          description: Service is healthy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
        '503':
          description: Service is up but a dependency is unreachable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
      security: []
components:
  schemas:
    Health:
      type: object
      required:
        - ok
        - db
      properties:
        ok:
          type: boolean
        db:
          type: string
          enum:
            - up
            - down
        version:
          type: string
        uptimeSec:
          type: number
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your API key: `Authorization: Bearer tokz_live_<id>_<secret>`. Only a
        SHA-256 hash of the secret is stored.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.