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

# Health check

> Liveness probe. `authenticated` reflects whether a valid API key was sent.



## OpenAPI

````yaml /openapi.yaml get /health
openapi: 3.1.0
info:
  title: Reechee Developer Platform API
  version: 1.0.0
  description: >
    The Reechee REST API exposes software-review pain points, buying signals,
    and

    sales opportunities.


    Two auth lanes share one base URL:


    - **Anonymous** (no key) - read-only, IP rate-limited. Product search, a
    free
      pain-points taste, and category competitors.
    - **API key** (`Authorization: Bearer rch_live_…`) - paid teams get full
      pain-point reports, opportunities, watchlist, credit balance, and safe write
      actions (follow/unfollow, triage).

    Every response uses a consistent envelope: `{ "success": true, "data": … }`
    on

    success (with an optional `meta`), or `{ "success": false, "error": {
    "code",

    "message", "details"? } }` on failure.
  contact:
    name: Reechee
    url: https://reechee.io
servers:
  - url: https://app.reechee.io/api/v1
    description: Production
security: []
tags:
  - name: System
    description: Health and connectivity.
  - name: Products
    description: Search products and read their pain points and competitors.
  - name: Opportunities
    description: Read and triage sales opportunities (API key required).
  - name: Watchlist
    description: Read and manage the team's followed products (API key required).
  - name: Account
    description: Team account data such as credit balance (API key required).
  - name: Credits
    description: >-
      Credit-spending actions (Tier 3). Requires a spend budget on the
      credential - a per-key spend cap for API keys, or the consent-time credit
      budget for OAuth connections.
paths:
  /health:
    get:
      tags:
        - System
      summary: Health check
      description: >-
        Liveness probe. `authenticated` reflects whether a valid API key was
        sent.
      operationId: getHealth
      responses:
        '200':
          description: Service is up.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    required:
                      - status
                      - authenticated
                    properties:
                      status:
                        type: string
                        example: ok
                      authenticated:
                        type: boolean
                        example: false
      security: []

````