mailjunky-ai Health API

openapi: 3.2.0
info:
  title: MailJunky Health API
  version: 1.0.0
  description: 'The MailJunky API lets you send transactional emails, track user events, manage contacts, and build intelligent email workflows. All endpoints require API key authentication unless noted otherwise.


    ## SDK


    Install the official SDK for the easiest integration:


    ```bash

    npm install @mailjunky/sdk

    ```


    ```typescript

    import { MailJunky } from ''@mailjunky/sdk''

    const mailjunky = new MailJunky({ apiKey: ''mj_live_xxx'' })

    ```


    For browser-side event tracking:


    ```typescript

    import { initMailJunky } from ''@mailjunky/sdk/browser''

    const mj = initMailJunky({ apiKey: ''mj_pub_xxx'' })

    ```


    ## Authentication


    Authenticate by including your API key in the `Authorization` header:


    ```

    Authorization: Bearer mj_live_your_api_key

    ```


    You can also use the `X-API-Key` header. Public keys (`mj_pub_*`) are restricted to event tracking only.


    ## Rate Limits


    All responses include rate limit headers:

    - `X-RateLimit-Limit` - Requests allowed per window

    - `X-RateLimit-Remaining` - Requests remaining

    - `X-RateLimit-Reset` - Window reset time (unix timestamp)

    - `Retry-After` - Seconds to wait (when rate limited)


    ## Base URL


    ```

    https://www.mailjunky.ai/api/v1

    ```'
  contact:
    name: MailJunky Support
    url: https://www.mailjunky.ai
    email: support@mailjunky.ai
servers:
- url: https://www.mailjunky.ai/api/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Health
  description: Service health checks
paths:
  /health:
    get:
      operationId: getHealth
      summary: Health check
      description: Check the health of the API and its dependencies. No authentication required.
      tags:
      - Health
      security: []
      responses:
        '200':
          description: Service health status
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - healthy
                    - degraded
                  timestamp:
                    type: string
                    format: date-time
                  version:
                    type: string
                  uptime:
                    type: number
                    description: Uptime in seconds
                  checks:
                    type: object
                    properties:
                      database:
                        type: object
                        properties:
                          status:
                            type: string
                            enum:
                            - ok
                            - error
                          latency_ms:
                            type: number
                  latency_ms:
                    type: number
              example:
                status: healthy
                timestamp: '2026-02-16T12:00:00.000Z'
                version: 1.0.0
                uptime: 86400
                checks:
                  database:
                    status: ok
                    latency_ms: 2
                latency_ms: 3
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Use your `mj_live_*` or `mj_pub_*` key as the bearer token.
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Alternative: pass your API key via the X-API-Key header.'
x-scalar-sdk-installation:
- lang: Node
  label: MailJunky SDK
  description: 'Install the official **MailJunky SDK** from npm:'
  source: npm install @mailjunky/sdk
- lang: JavaScript
  label: Browser SDK
  description: 'For browser-side event tracking:'
  source: npm install @mailjunky/sdk