mochify-app PDF API

openapi: 3.2.0
info:
  title: Mochify PDF API
  version: 1.0.0
  description: Mochify's REST API for zero-retention image compression, PDF page extraction/splitting, and AI image generation. Images and PDFs are streamed into RAM at api.mochify.app, processed, and returned; the original bytes are never written to disk. Authenticate with an x-api-key header (dashboard-issued key) for quota tracking, or omit auth entirely for anonymous, IP-metered use on the free tier.
  contact:
    url: https://mochify.app/docs
servers:
- url: https://api.mochify.app
  description: Production
security:
- bearerAuth: []
- apiKeyAuth: []
- {}
tags:
- name: PDF
  description: Rasterize a PDF to images, split it into single-page PDFs, or combine images into a PDF
paths:
  /v1/pdf:
    post:
      operationId: processPdf
      tags:
      - PDF
      summary: Rasterize, split, or create a PDF
      description: Operation selected by `op` (default `rasterize`). `rasterize` and `split` consume a PDF body (max 100 MB) and paid-plan-gated; `create` consumes one or more images and emits a PDF.
      parameters:
      - name: op
        in: query
        schema:
          type: string
          enum:
          - rasterize
          - split
          - create
          default: rasterize
      - name: type
        in: query
        schema:
          type: string
          enum:
          - png
          - jpg
          - jpeg
          - webp
          - avif
          - jxl
          default: png
        description: 'rasterize only: output image format for each rendered page.'
      - name: dpi
        in: query
        schema:
          type: integer
          minimum: 36
          maximum: 300
          default: 150
        description: rasterize only. (create uses its own dpi range, 36–600, default 96.)
      - name: quality
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 82
        description: 'rasterize/create: output quality.'
      - name: page
        in: query
        schema:
          type: string
          enum:
          - fit
          - a4
          - letter
          default: fit
        description: 'create only: output page size.'
      - name: maxWidth
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 16384
          default: 0
        description: 'create only: cap each page''s rendered width; 0 = unconstrained.'
      - name: combine
        in: query
        schema:
          type: boolean
          default: true
        description: 'create only: true (default) combines all input images into one multi-page PDF; false returns one single-page PDF per image, zipped.'
      requestBody:
        required: true
        content:
          application/pdf:
            schema:
              type: string
              format: binary
              description: op=rasterize or op=split.
          application/octet-stream:
            schema:
              type: string
              format: binary
              description: op=create with a single raw image body.
          multipart/form-data:
            schema:
              type: object
              description: op=create with several images, each appended as `images`; one PDF page per image in upload order.
              properties:
                images:
                  type: array
                  items:
                    type: string
                    format: binary
      responses:
        '200':
          description: 'rasterize/split: a ZIP of images or single-page PDFs. create: a single application/pdf, or a ZIP if combine=false.'
          headers:
            X-Latency-Ms:
              schema:
                type: integer
            X-Mochify-Pages:
              schema:
                type: integer
              description: 'split only: number of pages produced.'
          content:
            application/zip: {}
            application/pdf: {}
        '400':
          description: Empty body, unsupported op/type/page value, or invalid quality/dpi/maxWidth.
          content:
            text/plain: {}
        '413':
          description: Input over 100 MB, or output over the 300 MB in-RAM ZIP ceiling.
          content:
            text/plain: {}
        '503':
          description: Worker pool at capacity.
          headers:
            Retry-After:
              schema:
                type: integer
          content:
            text/plain: {}
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Dashboard-issued API key sent as `Authorization: Bearer <key>`. This is the header documented on /docs and in the dashboard, and the one to prefer. A signed-in session token is accepted here too. Note: a bearer token that cannot be resolved does not fail the request, it falls through to anonymous IP-based free-tier limits, so a wrong key behaves exactly like sending no key at all. Send the key as x-api-key instead if you want an unusable key reported back to you.'
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: The same dashboard-issued API key, sent in the x-api-key header. Used by /v1/squish, /v1/pdf, /v1/generate, /v1/checkTokens, /v1/upload/*. Unlike the bearer header, a key that cannot be resolved is reported as invalid rather than silently downgraded. If no credential is sent at all, these endpoints fall back to anonymous IP-based rate limiting on the free tier rather than rejecting the request.