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

# Health

> Liveness probe reporting which compute substrate serves traffic.



## OpenAPI

````yaml /api-reference/openapi.json get /health
openapi: 3.1.0
info:
  description: |
    The Bigspin Annotation API annotates conversation transcripts with named,
    versioned annotators (for example ``universal-signals``).

    ## Authentication

    Every endpoint except ``/health`` and the docs surface requires a Bigspin
    API key sent as a bearer token:

    ```
    Authorization: Bearer bsk_...
    ```

    Requests without a valid key receive ``401``; revoked or disabled keys
    receive ``403``.

    ## Rate limits

    Requests are rate-limited per key (fixed window). When the limit is
    exceeded the API responds ``429`` with a ``Retry-After`` header. Provider
    capacity is additionally governed globally; saturation also surfaces as
    ``429`` + ``Retry-After``.

    ## Errors

    Every error response uses one envelope: ``{"error": ..., "detail": ...}``.

    The service runs on two substrates (Fargate/FastAPI and Lambda/ALBResolver)
    behind api-dev.bigspin.ai; the FastAPI edge's OpenAPI spec is canonical.
  summary: Synchronous transcript annotation over Bigspin's annotator registry.
  title: Bigspin Annotation API
  version: 0.1.0
servers:
  - description: Development
    url: https://api-dev.bigspin.ai
security: []
tags:
  - description: Unauthenticated liveness probe reporting the serving substrate.
    name: health
  - description: >-
      Synchronous transcript annotation and the public registry of available
      annotators.
    name: annotations
  - description: >-
      Asynchronous batch annotation. Spec'd in v1 but not yet implemented —
      endpoints return 501 (see RFC 000055).
    name: batches
paths:
  /health:
    get:
      tags:
        - health
      summary: Health
      description: Liveness probe reporting which compute substrate serves traffic.
      operationId: health_health_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
          description: Successful Response
components:
  schemas:
    HealthResponse:
      description: |-
        Response body for ``GET /health`` on both edges.

        ``substrate`` reports which compute substrate is serving traffic
        (``"fargate"`` or ``"lambda"``), sourced from ``BIGSPIN_SUBSTRATE``.
      properties:
        status:
          title: Status
          type: string
        substrate:
          title: Substrate
          type: string
      required:
        - status
        - substrate
      title: HealthResponse
      type: object

````