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

# Server + provider snapshot

> Unauthenticated. Returns server identity, the cached cloud-provider health snapshot, and the installed local-model inventory.



## OpenAPI

````yaml /api-reference/local-api/openapi.yaml get /health
openapi: 3.0.3
info:
  title: HyperWhisper Local API
  description: >
    HTTP API exposed by HyperWhisper.app on `127.0.0.1` when the user enables

    Settings → API Server. Off by default. Used by MCP wrappers, benchmarking

    scripts, and power-user automation.


    **Port + token discovery.** The server writes

    `~/Library/Application Support/HyperWhisper/local-api.json`

    (chmod 600) on every start. Clients read that file to find the port

    and bearer token — neither value is hard-coded.


    **Response envelope.** Successful calls return `{"ok": true, ...}` with

    HTTP 200. Expected business failures (model not installed, missing API

    key, file not found, transcription engine errored, etc.) also return HTTP

    200 with `{"ok": false, "error": {"code": "...", "message": "...", "hint":
    "..."}}`.

    HTTP 4xx is reserved for protocol failures: malformed JSON (400), missing

    or invalid bearer token (401).
  version: 1.0.0
servers:
  - url: http://127.0.0.1:{port}
    description: >-
      Local-only loopback. The port is dynamic — read it from the discovery
      file.
    variables:
      port:
        default: '39201'
        description: >-
          Persisted port from `~/Library/Application
          Support/HyperWhisper/local-api.json`.
security:
  - bearerAuth: []
paths:
  /health:
    get:
      summary: Server + provider snapshot
      description: >-
        Unauthenticated. Returns server identity, the cached cloud-provider
        health snapshot, and the installed local-model inventory.
      responses:
        '200':
          description: Health snapshot
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        ok:
          type: boolean
        app_version:
          type: string
        api_version:
          type: integer
        port:
          type: integer
        pid:
          type: integer
        providers:
          type: array
          items:
            $ref: '#/components/schemas/HealthProvider'
        post_processing_providers:
          type: array
          items:
            $ref: '#/components/schemas/HealthProvider'
        local_models:
          $ref: '#/components/schemas/HealthLocalModels'
    HealthProvider:
      type: object
      properties:
        id:
          type: string
        key_present:
          type: boolean
        reachable:
          type: boolean
        status:
          type: string
          enum:
            - unknown
            - checking
            - healthy
            - unauthorized
            - unreachable
            - notInstalled
    HealthLocalModels:
      type: object
      properties:
        whisper:
          type: array
          items:
            $ref: '#/components/schemas/HealthLocalModelEntry'
        parakeet:
          type: array
          items:
            $ref: '#/components/schemas/HealthLocalModelEntry'
        qwen3_asr:
          type: array
          items:
            $ref: '#/components/schemas/HealthLocalModelEntry'
        apple_speech:
          type: array
          items:
            $ref: '#/components/schemas/HealthLocalModelEntry'
        local_llm:
          type: array
          items:
            $ref: '#/components/schemas/HealthLocalModelEntry'
    HealthLocalModelEntry:
      type: object
      properties:
        id:
          type: string
        displayName:
          type: string
        installed:
          type: boolean
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: base64-url
      description: >-
        Token from the discovery file. Required on every endpoint except
        /health.

````