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

> ## Agent Instructions
> BuzzKit is an open source notification orchestration layer. Send mobile push from a backend with one POST to /v1/messages, targeting a subscriber id, a topic, a saved segment or an inline expression. Subscribers are addressed by the caller's own user ids. Authenticate with a bearer API key from the dashboard; workspace keys pick a tenant with the BuzzKit-Tenant header. Every response is the envelope { success, data, error, metadata } and errors carry a stable snake_case code. iOS is the supported client SDK. The machine-readable API description is at https://buzzkit.dev/openapi.json.

# Get health



## OpenAPI

````yaml /openapi.json get /v1/health
openapi: 3.0.3
info:
  title: BuzzKit API
  version: 1.0.0
  description: >-
    The BuzzKit REST API: subscribers, subscriptions, topics, events, segments,
    messages, workflows, sources and webhooks, all under /v1. Every response is
    a JSON envelope { success, data, error, metadata }; errors carry a lowercase
    snake_case code, a message and, when a field is at fault, its param.
  contact:
    name: BuzzKit
    url: https://buzzkit.dev
    email: hello@buzzkit.dev
  license:
    name: AGPL-3.0
    url: https://github.com/buzzkit-dev/buzzkit/blob/main/LICENSE
servers:
  - url: https://api.buzzkit.dev
    description: BuzzKit Cloud
  - url: http://localhost:8790
    description: Local development
security:
  - bearerAuth: []
externalDocs:
  description: BuzzKit documentation
  url: https://docs.buzzkit.dev
paths:
  /v1/health:
    get:
      summary: Get health
      operationId: getHealth
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - error
                  - metadata
                properties:
                  success:
                    type: boolean
                  data:
                    nullable: true
                    type: object
                    additionalProperties: true
                  error:
                    nullable: true
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      param:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                  metadata:
                    type: object
                    required:
                      - timestamp
                    properties:
                      timestamp:
                        type: string
                      requestId:
                        type: string
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from the dashboard. The scopes listed on each operation are
        the `resource:action` grants a key needs (`messages:send`,
        `subscribers:read`, `topics:*`, `*`); `account:*` scopes and key
        management are session-only. Workspace keys (bk_ws_) reach every tenant
        and pick one with the buzzkit-tenant header; tenant keys (bk_tn_) are
        locked to one tenant; client keys (bk_pk_) ship inside an app and only
        work on /v1/client/*.

````