Bernstein Health API

openapi: 3.2.0
info:
  title: Bernstein Task Server Health API
  description: 'Bernstein REST API - the open-source governance layer for AI agents, one git worktree per task.


    ## Authentication


    Authentication is ENABLED by default. Include a Bearer token in all requests:


    ```

    Authorization: Bearer

    ```


    To run without auth (development only), set `BERNSTEIN_AUTH_DISABLED=1` - this logs a loud warning and passes every request through.


    Public endpoints (no auth required): `/health`, `/health/ready`, `/health/live`, `/ready`, `/alive`, `/.well-known/agent.json`, `/docs`, `/openapi.json`, and the auth-flow endpoints (`/auth/login`, `/auth/oidc/callback`, etc.).


    Webhook and hook endpoints (`/webhook`, `/webhooks/*`, `/hooks/{session_id}`) authenticate via HMAC-SHA256 signatures - they do NOT accept Bearer tokens.


    ## Base URL


    Default: `http://127.0.0.1:8052`. Override with env vars `BERNSTEIN_HOST` and `BERNSTEIN_PORT`.


    ## Error Format


    All errors return JSON with a `detail` field:


    ```json

    {"detail": "Task not found: task-xyz"}

    ```


    | Status | Meaning |

    |--------|---------|

    | 400 | Bad request (validation error) |

    | 401 | Unauthorized (missing/invalid token) |

    | 403 | Forbidden (IP not in allowlist) |

    | 404 | Resource not found |

    | 409 | Conflict (task already in terminal state) |

    | 429 | Rate limited - respect the `Retry-After` header |

    | 500 | Internal server error |'
  version: 3.22.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: Alex Chernysh
    url: https://github.com/sipyourdrink-ltd/bernstein
servers:
- url: http://{host}:{port}
  description: Task server started by the Bernstein CLI on the operator's own machine. There is no hosted instance; substitute the host and port of your install.
  variables:
    host:
      default: 127.0.0.1
      description: Interface the task server binds to. Loopback by default.
    port:
      default: '8052'
      description: Task server port. Override with BERNSTEIN_PORT.
tags:
- name: Health
paths:
  /health:
    get:
      summary: Health Check
      description: Liveness check with component-level status.
      operationId: health_check_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      tags:
      - Health
  /health/ready:
    get:
      summary: Ready Check
      description: Readiness check for load balancers.
      operationId: ready_check_health_ready_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Health
  /health/live:
    get:
      summary: Live Check
      description: Liveness check for process monitoring.
      operationId: live_check_health_live_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Health
  /health/deps:
    get:
      summary: Health Deps
      description: 'Return health status with dependency checks.


        Checks: server, store, adapters, sse_bus.

        Overall status is ``healthy`` if all dependencies are ok,

        ``degraded`` if any are degraded, ``unhealthy`` if any are down.'
      operationId: health_deps_health_deps_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthDepsResponse'
      tags:
      - Health
  /api/v1/health:
    get:
      summary: Health Check
      description: Liveness check with component-level status.
      operationId: health_check_api_v1_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      tags:
      - Health
  /api/v1/health/ready:
    get:
      summary: Ready Check
      description: Readiness check for load balancers.
      operationId: ready_check_api_v1_health_ready_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Health
  /api/v1/health/live:
    get:
      summary: Live Check
      description: Liveness check for process monitoring.
      operationId: live_check_api_v1_health_live_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Health
  /api/v1/health/deps:
    get:
      summary: Health Deps
      description: 'Return health status with dependency checks.


        Checks: server, store, adapters, sse_bus.

        Overall status is ``healthy`` if all dependencies are ok,

        ``degraded`` if any are degraded, ``unhealthy`` if any are down.'
      operationId: health_deps_api_v1_health_deps_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthDepsResponse'
      tags:
      - Health
components:
  schemas:
    HealthResponse:
      properties:
        status:
          type: string
          title: Status
        uptime_s:
          type: number
          title: Uptime S
        task_count:
          type: integer
          title: Task Count
        agent_count:
          type: integer
          title: Agent Count
        task_queue_depth:
          type: integer
          title: Task Queue Depth
          default: 0
        memory_mb:
          type: number
          title: Memory Mb
          default: 0
        restart_count:
          type: integer
          title: Restart Count
          default: 0
        is_readonly:
          type: boolean
          title: Is Readonly
          default: false
        components:
          additionalProperties:
            additionalProperties: true
            type: object
          type: object
          title: Components
      type: object
      required:
      - status
      - uptime_s
      - task_count
      - agent_count
      title: HealthResponse
      description: Response for GET /health.
    DependencyStatus:
      properties:
        name:
          type: string
          title: Name
        status:
          type: string
          title: Status
        latency_ms:
          type: number
          title: Latency Ms
          default: 0
        detail:
          type: string
          title: Detail
          default: ''
      type: object
      required:
      - name
      - status
      title: DependencyStatus
      description: Status of a single dependency.
    HealthDepsResponse:
      properties:
        status:
          type: string
          title: Status
        uptime_s:
          type: number
          title: Uptime S
        timestamp:
          type: number
          title: Timestamp
        dependencies:
          items:
            $ref: '#/components/schemas/DependencyStatus'
          type: array
          title: Dependencies
      type: object
      required:
      - status
      - uptime_s
      - timestamp
      title: HealthDepsResponse
      description: Full health response with dependency checks.