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

# Check service readiness

> No API key required. Readiness checks Redis, database connectivity, unpaused queue processing, and available worker heartbeats. A healthy response is not a latency guarantee.



## OpenAPI

````yaml /openapi.json get /v1/health
openapi: 3.1.0
info:
  title: ScreenshotAPI
  version: 1.0.0
  description: >-
    Hosted ScreenshotAPI capture endpoints, authentication, request options, and
    response envelopes.
servers:
  - url: https://api.screenshotapi.tech
    description: ScreenshotAPI production REST API
security:
  - bearerAuth: []
tags:
  - name: Captures
  - name: Jobs
  - name: Webhook delivery
  - name: Service
paths:
  /v1/health:
    get:
      tags:
        - Service
      summary: Check service readiness
      description: >-
        No API key required. Readiness checks Redis, database connectivity,
        unpaused queue processing, and available worker heartbeats. A healthy
        response is not a latency guarantee.
      operationId: getHealth
      responses:
        '200':
          description: Service ready.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '503':
          description: Service is not ready; some diagnostics can be absent on an outage.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        ok:
          type: boolean
        data:
          type: object
          properties:
            redis:
              type: string
              enum:
                - ready
                - unavailable
            database:
              type: string
              enum:
                - ready
                - unavailable
            worker_ready:
              type: boolean
            ready_workers:
              type: integer
            queue:
              type: object
              properties:
                waiting:
                  type: integer
                active:
                  type: integer
                prioritized:
                  type: integer
                delayed:
                  type: integer
                completed:
                  type: integer
                failed:
                  type: integer
                paused:
                  type: boolean
                total_pending:
                  type: integer
              required:
                - waiting
                - active
                - prioritized
                - delayed
                - completed
                - failed
                - paused
                - total_pending
            settlement:
              type: object
              additionalProperties:
                type: number
            webhooks:
              type: object
              properties:
                delivered:
                  type: integer
                failed:
                  type: integer
                errors:
                  type: integer
                active:
                  type: boolean
              required:
                - delivered
                - failed
                - errors
                - active
          required:
            - redis
            - worker_ready
      required:
        - ok
        - data
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Active sf_live_ API key with endpoint-specific scopes. Keep this
        credential server-side.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.