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

# Health Check

> Check if the API is running



## OpenAPI

````yaml GET /health
openapi: 3.1.0
info:
  title: MetaLink API
  version: 1.0.0
  description: >
    A fast REST API that accepts a URL and returns structured metadata — Open
    Graph tags, Twitter Cards, favicons, titles, and descriptions.
  contact:
    url: https://metalink.mintlify.app
  license:
    name: MIT
servers:
  - url: https://api.metalinkapi.com
    description: Production
security:
  - ApiKeyHeader: []
  - ApiKeyQuery: []
paths:
  /health:
    get:
      summary: Health check
      description: Public health check endpoint. No authentication required.
      operationId: healthCheck
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
      security: []
components:
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: Pass your API key in the `X-API-Key` header (recommended)
    ApiKeyQuery:
      type: apiKey
      in: query
      name: api_key
      description: Pass your API key as the `api_key` query parameter

````