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

# Health check

> Unauthenticated liveness probe.



## OpenAPI

````yaml /api-reference/openapi.json get /health
openapi: 3.1.0
info:
  title: Brewgravity API
  version: 1.0.0
  description: >-
    Read and write your recipes, brew sessions, fermentation logs, and
    ingredient inventory.


    Every request is scoped to the account its credential belongs to — there is
    no `user_id` parameter anywhere, and an id belonging to someone else returns
    `404`.


    All units are metric: kilograms, grams, litres, degrees Celsius, minutes.
  contact:
    name: Brewgravity support
    email: support@brewgravity.com
servers:
  - url: https://brewgravity.com
    description: Production
  - url: http://localhost:8787
    description: Local development
security:
  - apiKey: []
tags:
  - name: Identity
    description: Who the credential belongs to.
  - name: Recipes
    description: Recipes and their computed stats.
  - name: Fermentables
    description: Grain, sugar, and extract on a recipe.
  - name: Hops
    description: Hop additions on a recipe.
  - name: Yeasts
    description: Yeast on a recipe.
  - name: Other ingredients
    description: Finings, salts, spices, and flavourings.
  - name: Mash steps
    description: A recipe's mash schedule.
  - name: Brew sessions
    description: Individual brew days made from a recipe.
  - name: Brew day steps
    description: The checklist attached to a brew session.
  - name: Fermentation logs
    description: Timestamped readings against a brew session.
  - name: Inventory
    description: Ingredients you physically have on hand.
  - name: AI
    description: Recipe analysis and usage metering.
  - name: Chats
    description: >-
      AI chat threads. The streaming turn endpoint is not part of the REST
      surface.
paths:
  /health:
    get:
      tags:
        - Identity
      summary: Health check
      description: Unauthenticated liveness probe.
      operationId: health
      responses:
        '200':
          description: The API is up
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    description: Always true
      security: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: An API key created from a signed-in session. See Authentication.

````