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

# Check service health

> Public and unauthenticated. Returns `ok: true` while the service is up. A healthy service can still fail a job.



## OpenAPI

````yaml /openapi.json get /health
openapi: 3.1.0
info:
  title: bapsolver API
  version: 0.2.0
  description: >-
    Submit a token job for a page and its public reCAPTCHA v3 site key, then
    poll the job for the token.
servers:
  - url: https://api.bapsolver.xyz
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Jobs
    description: Create, read, list and cancel token jobs.
  - name: Service
    description: Service health.
paths:
  /health:
    get:
      tags:
        - Service
      summary: Check service health
      description: >-
        Public and unauthenticated. Returns `ok: true` while the service is up.
        A healthy service can still fail a job.
      operationId: getHealth
      responses:
        '200':
          description: Service status.
          headers:
            X-Request-Id:
              schema:
                type: string
                format: uuid
                description: >-
                  Server-generated correlation identifier; caller-supplied
                  identifiers are ignored.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    const: true
                  requestId:
                    type: string
                    format: uuid
                    description: >-
                      Server-generated correlation identifier; caller-supplied
                      identifiers are ignored.
                  data:
                    type: object
                required:
                  - ok
                  - requestId
                  - data
                additionalProperties: false
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your API token. Send it on every /v1 request as `Authorization: Bearer
        <API_TOKEN>`.

````

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