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

# Health Check

> Check API availability. No authentication required. Returns 200 when healthy.



## OpenAPI

````yaml /openapi.json get /v1/health
openapi: 3.0.3
info:
  title: SuperDoc API
  version: 0.9.0
  description: >-
    ## Quick Start


    1 - **Register**:
    https://api.superdoc.dev/v1/auth/register?email=you@email.com


    2 - **Verify**: Check email, then
    https://api.superdoc.dev/v1/auth/verify?email=you@email.com&code=123456


    3 - **Convert**

    ```bash

    curl -X POST https://api.superdoc.dev/v1/convert?from=docx \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -F "file=@document.docx" \
      -o converted.pdf
    ```



    Or use our Playground:

    https://api.superdoc.dev/docs/#tag/documents/post/v1/convert


    That's it! Your DOCX is now a PDF.


    ---


    [Status](https://status.superdoc.dev) •
    [GitHub](https://github.com/superdoc-dev/superdoc)
  contact:
    name: Support
    email: api@superdoc.dev
    url: https://superdoc.dev/contact-us
  license:
    name: Commercial
    url: https://superdoc.dev
servers:
  - url: https://api.superdoc.dev
    description: Production
security: []
tags:
  - name: Documents
    description: Document conversion and transformation
  - name: Authentication
    description: Registration and API key management
  - name: System
    description: Health and service information
paths:
  /v1/health:
    get:
      tags:
        - System
      summary: Health Check
      description: >-
        Check API availability. No authentication required. Returns 200 when
        healthy.
      operationId: checkHealth
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - timestamp
                  - version
                properties:
                  status:
                    type: string
                    enum:
                      - healthy
                  timestamp:
                    type: string
                    format: date-time
                  version:
                    type: string
                  deployment:
                    type: object
                    properties:
                      service:
                        type: string
                      revision:
                        type: string
                      configuration:
                        type: string
                  instance:
                    type: object
                    properties:
                      startTime:
                        type: string
                        format: date-time
                      uptime:
                        type: number
              example:
                status: healthy
                timestamp: '2024-01-15T10:30:00Z'
                version: 1.2.3
                deployment:
                  region: us-east1
                  environment: production

````