> ## 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.

# Status and metrics

> Returns a service descriptor with the current queue depth, worker count, and a catalogue of exposed endpoints.



## OpenAPI

````yaml /api-reference/cli/openapi.json get /
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:
  /:
    get:
      tags:
        - System
      summary: Status and metrics
      description: >-
        Returns a service descriptor with the current queue depth, worker count,
        and a catalogue of exposed endpoints.
      operationId: status
      responses:
        '200':
          description: Service descriptor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
              example:
                name: ScreenJSON CLI API
                version: 1.0.0
                status: running
                queue:
                  pending: 0
                  workers: 8
                endpoints:
                  - method: GET
                    path: /
                    description: Queue status and metrics
                  - method: GET
                    path: /health
                    description: Health check
                  - method: GET
                    path: /formats
                    description: List supported formats
                  - method: POST
                    path: /convert
                    description: Upload file -> ScreenJSON response
                  - method: POST
                    path: /export
                    description: Upload ScreenJSON -> format response
                  - method: POST
                    path: /validate
                    description: Validate ScreenJSON document
components:
  schemas:
    Status:
      type: object
      properties:
        name:
          type: string
        version:
          type: string
        status:
          type: string
          enum:
            - running
        queue:
          $ref: '#/components/schemas/QueueStatus'
        endpoints:
          type: array
          items:
            type: object
            properties:
              method:
                type: string
              path:
                type: string
              description:
                type: string
    QueueStatus:
      type: object
      properties:
        pending:
          type: integer
          description: Number of jobs waiting in the queue.
        workers:
          type: integer
          description: Worker pool size.

````