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

# GET /health

> Check whether the IntegrationCompressFunction service is reachable.

## Overview

Use this endpoint for uptime checks, smoke tests, and basic monitoring.

## Notes

* No API key is required.
* This endpoint confirms service availability only.
* It does not validate API keys or billing state.


## OpenAPI

````yaml /openapi.yaml GET /health
openapi: 3.0.3
info:
  title: SmartPNG Integration API
  description: >
    SmartPNG Integration API for backend services, CMS plugins, and automation
    flows.


    This API provides synchronous image compression with credit-based billing.


    ## Authentication

    Provide the API key in the request payload:

    - `/compress`: multipart form field `api_key`

    - `/validate`: JSON body field `api_key`


    ## Billing

    - Each successful compression costs `1` credit

    - Every account receives `500` free credits per month

    - Additional credits can be purchased from the SmartPNG dashboard
  version: 1.0.0
  contact:
    name: SmartPNG Support
    email: contact@smartpng.com
    url: https://smartpng.com
servers:
  - url: https://integration.smartpng.com/api
    description: Production
security: []
tags:
  - name: Compression
    description: Image compression operations
  - name: Validation
    description: API key validation and credit checks
  - name: Health
    description: Service status
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health check
      description: |
        Check whether the IntegrationCompressFunction service is reachable.
      operationId: healthCheck
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              examples:
                healthy:
                  summary: Healthy service
                  value:
                    status: healthy
                    service: IntegrationCompressFunction
components:
  schemas:
    HealthResponse:
      type: object
      required:
        - status
        - service
      properties:
        status:
          type: string
          enum:
            - healthy
          example: healthy
        service:
          type: string
          example: IntegrationCompressFunction

````