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

# Liveness



## OpenAPI

````yaml /openapi.yaml get /healthz
openapi: 3.1.0
info:
  title: spoolpdf API
  version: 0.1.0
  description: |
    HTML/URL to PDF render API.

    Error codes returned in `ErrorEnvelope.error.code`:
    `unauthorized`, `validation_error`, `ssrf_blocked`, `rate_limited`,
    `concurrency_limit`, `payload_too_large`, `render_failed`,
    `subscription_inactive`.

    `concurrency_limit` means your plan's parallel render allowance is full
    (Free 1, Starter 2, Growth 4, Scale 8). Retry after the interval in
    `Retry-After`; the allowance is echoed in `X-Concurrency-Limit`.
servers:
  - url: https://spoolpdf-api.nandra.dev
    description: Production
  - url: http://localhost:8080
    description: Local Compose
security: []
tags:
  - name: Render
    description: Authenticated HTML or URL to PDF.
  - name: Trial
    description: >-
      Unauthenticated smoke-test render. IP rate-limited. Does not increment
      usage.
  - name: Health
    description: Liveness and readiness probes.
paths:
  /healthz:
    get:
      tags:
        - Health
      summary: Liveness
      operationId: getHealthz
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
components:
  schemas:
    HealthResponse:
      type: object
      required:
        - ok
      properties:
        ok:
          type: boolean

````