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

# Public health probe

> Reports the status of the API + its critical dependencies (DB,
Redis, audit buffer). Returns `200` when all OK, `503` with
`status: degraded` when any dependency is unhealthy.

Cached for 5 seconds via `Cache-Control: public, max-age=5`.
Bypasses authentication and rate limiting — safe for monitors.




## OpenAPI

````yaml /openapi/v1.yaml get /health
openapi: 3.1.0
info:
  title: Scripe Public API
  version: '2026-08-01'
  summary: Read-only access to Scripe workspaces, projects, notes, posts, and sources.
  description: |
    The Scripe public API gives integrators stable, versioned read access
    to a workspace's content surface. Phase 2 ships read endpoints only;
    write endpoints land in Phase 3.

    All endpoints (except `/v1/health`) require a Bearer API key. Pin the
    API version with the `Scripe-Api-Version` request header to opt out
    of breaking changes.
  contact:
    name: Scripe Support
    url: https://scripe.io/support
    email: support@scripe.io
  license:
    name: Proprietary
servers:
  - url: https://api.scripe.io/v1
    description: Production
security:
  - BearerApiKey: []
tags:
  - name: Health
    description: Liveness and authenticated key smoke tests.
  - name: Workspace
    description: The workspace + principal resolved from your API key.
  - name: Projects
    description: Personal-brand, company-page, and amplifier projects.
  - name: Notes
    description: Project notes with paired calendar slot.
  - name: Posts
    description: Drafts, scheduled, and published LinkedIn posts.
  - name: Analytics
    description: Your own LinkedIn analytics and viral-post inspiration search.
  - name: Sources
    description: Transcriptions (audio/video sources) with truncated body.
  - name: Uploads
    description: >-
      Pre-signed S3 PUT URLs the customer uploads bytes to before referencing
      via Sources or Knowledge.
  - name: Knowledge
    description: >-
      Knowledge-base documents indexed for RAG. Async ingest via text, file,
      URL, or YouTube.
  - name: Jobs
    description: >-
      Async-job lifecycle — submitted via post-generation, knowledge ingest,
      file source.
  - name: Webhooks
    description: |
      Outbound HTTP callbacks. Subscribe an endpoint to one or more
      event names; we POST a signed JSON payload every time a matching
      event fires in the workspace. The signing secret is shown once
      on create and once on rotate — verify the
      `Webhook-Signature: t=<ts>,v1=<hmac>` header on every delivery.
paths:
  /health:
    get:
      tags:
        - Health
      summary: Public health probe
      description: |
        Reports the status of the API + its critical dependencies (DB,
        Redis, audit buffer). Returns `200` when all OK, `503` with
        `status: degraded` when any dependency is unhealthy.

        Cached for 5 seconds via `Cache-Control: public, max-age=5`.
        Bypasses authentication and rate limiting — safe for monitors.
      operationId: getHealth
      responses:
        '200':
          description: All dependencies healthy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
        '503':
          description: One or more dependencies degraded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
      security: []
components:
  schemas:
    Health:
      type: object
      required:
        - status
        - version
        - checks
      properties:
        status:
          type: string
          enum:
            - ok
            - degraded
        version:
          type: string
          example: '2026-08-01'
        checks:
          type: object
          required:
            - db
            - redis
            - auditBuffer
          properties:
            db:
              type: object
              required:
                - ok
                - latencyMs
              properties:
                ok:
                  type: boolean
                latencyMs:
                  type: integer
                  minimum: 0
            redis:
              type: object
              required:
                - ok
                - latencyMs
              properties:
                ok:
                  type: boolean
                latencyMs:
                  type: integer
                  minimum: 0
            auditBuffer:
              type: object
              required:
                - ok
                - depth
              properties:
                ok:
                  type: boolean
                depth:
                  type: integer
                  minimum: 0
  securitySchemes:
    BearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: scripe_sk_live_*
      description: |
        Pass `Authorization: Bearer scripe_sk_live_<...>` (or
        `scripe_sk_test_<...>` for test keys) on every request. Keys
        are scoped to a single workspace and can be revoked from the
        Scripe dashboard.

````