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

# Health check

> Returns overall service health plus per-dependency status for any configured external services (Gotenberg, Tika, LLM).



## OpenAPI

````yaml /api-reference/cli/openapi.json get /health
openapi: 3.1.0
info:
  title: screenjson-cli REST API
  description: >-
    REST API exposed by `screenjson serve`. Wraps the same conversion, export,
    validation, and schema engine as the CLI.


    Start locally with `screenjson serve --host 0.0.0.0 --port 8080`.
  version: 1.0.0
  contact:
    name: ScreenJSON
    url: https://screenjson.com
servers:
  - url: http://localhost:8080
    description: Local development
  - url: https://api.try.screenjson.com
    description: Public demo API
security: []
paths:
  /health:
    get:
      tags:
        - System
      summary: Health check
      description: >-
        Returns overall service health plus per-dependency status for any
        configured external services (Gotenberg, Tika, LLM).
      operationId: health
      responses:
        '200':
          description: Health report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
              example:
                status: ok
                queue:
                  pending: 0
                  workers: 8
                services:
                  gotenberg: ok
                  tika: ok
components:
  schemas:
    Health:
      type: object
      properties:
        status:
          type: string
          enum:
            - ok
        queue:
          $ref: '#/components/schemas/QueueStatus'
        services:
          type: object
          additionalProperties:
            type: string
    QueueStatus:
      type: object
      properties:
        pending:
          type: integer
          description: Number of jobs waiting in the queue.
        workers:
          type: integer
          description: Worker pool size.

````