PDFMonkey

PDFMonkey is a document generation service that turns HTML + Liquid templates and a JSON data payload into PDF (or image) documents via a REST API. Templates are designed in a dashboard editor and generated on demand, asynchronously or synchronously, with webhooks and signed download URLs for delivery.

4 APIs 0 Features

PDFDocument GenerationTemplatesHTML to PDFDocuments

APIs

PDFMonkey Documents API

Create, retrieve, update, and delete documents. A document is generated from a template plus a JSON payload, asynchronously by setting status to pending, or synchronously via th...

PDFMonkey Document Cards API

Lightweight, paginated document representations that omit the heavy payload attribute. Used to poll generation status and retrieve download URLs efficiently, and to list documen...

PDFMonkey Templates API

List, retrieve, create, update, and delete document templates. Templates hold published and draft HTML + Liquid bodies, SCSS styles, sample data, and printing settings. Lightwei...

PDFMonkey Webhooks

Real-time notifications fired on documents.generation.success and documents.generation.failure. The webhook delivers a DocumentCard payload (no dynamic payload, logs, or checksu...

Collections

PDFMonkey API

OPEN

Pricing Plans

Pdfmonkey Plans Pricing

7 plans

PLANS

Rate Limits

Pdfmonkey Rate Limits

2 limits

RATE LIMITS

FinOps

Pdfmonkey Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: PDFMonkey API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Documents
    type: folder
  items:
  - info:
      name: Create a document
      type: http
    http:
      method: POST
      url: https://api.pdfmonkey.io/api/v1/documents
      body:
        type: json
        data: "{\n  \"document\": {\n    \"document_template_id\": \"<uuid>\",\n    \"status\": \"pending\",\n    \"payload\"\
          : {},\n    \"meta\": { \"_filename\": \"invoice.pdf\" }\n  }\n}"
    docs: Create a new document from a template and payload. Set status to pending to queue generation.
  - info:
      name: Create a document synchronously
      type: http
    http:
      method: POST
      url: https://api.pdfmonkey.io/api/v1/documents/sync
      body:
        type: json
        data: "{\n  \"document\": {\n    \"document_template_id\": \"<uuid>\",\n    \"payload\": {},\n    \"meta\": {}\n \
          \ }\n}"
    docs: Create a document and block until generation completes.
  - info:
      name: Fetch a document
      type: http
    http:
      method: GET
      url: https://api.pdfmonkey.io/api/v1/documents/{{documentId}}
    docs: Retrieve a full document including payload and generation logs.
  - info:
      name: Update a document
      type: http
    http:
      method: PUT
      url: https://api.pdfmonkey.io/api/v1/documents/{{documentId}}
      body:
        type: json
        data: "{\n  \"document\": {\n    \"status\": \"pending\",\n    \"payload\": {}\n  }\n}"
    docs: Update a draft document's payload, metadata, or template, or trigger generation.
  - info:
      name: Delete a document
      type: http
    http:
      method: DELETE
      url: https://api.pdfmonkey.io/api/v1/documents/{{documentId}}
    docs: Permanently delete a document.
- info:
    name: Document Cards
    type: folder
  items:
  - info:
      name: List document cards
      type: http
    http:
      method: GET
      url: https://api.pdfmonkey.io/api/v1/document_cards
    docs: List documents as lightweight cards with pagination and filtering (status, template, workspace, updated_since).
  - info:
      name: Fetch a document card
      type: http
    http:
      method: GET
      url: https://api.pdfmonkey.io/api/v1/document_cards/{{documentId}}
    docs: Retrieve a lightweight document card to poll status and obtain the download URL.
- info:
    name: Templates
    type: folder
  items:
  - info:
      name: Create a template
      type: http
    http:
      method: POST
      url: https://api.pdfmonkey.io/api/v1/document_templates
      body:
        type: json
        data: "{\n  \"document_template\": {\n    \"identifier\": \"Invoice\",\n    \"body\": \"<html>...</html>\",\n    \"\
          scss_style\": \"\",\n    \"sample_data\": \"{}\"\n  }\n}"
    docs: Create a new document template.
  - info:
      name: Fetch a template
      type: http
    http:
      method: GET
      url: https://api.pdfmonkey.io/api/v1/document_templates/{{templateId}}
    docs: Retrieve full template details including body, styles, and sample data.
  - info:
      name: Update a template
      type: http
    http:
      method: PUT
      url: https://api.pdfmonkey.io/api/v1/document_templates/{{templateId}}
      body:
        type: json
        data: "{\n  \"document_template\": {\n    \"body\": \"<html>...</html>\"\n  }\n}"
    docs: Update an existing document template.
  - info:
      name: Delete a template
      type: http
    http:
      method: DELETE
      url: https://api.pdfmonkey.io/api/v1/document_templates/{{templateId}}
    docs: Permanently delete a document template.
  - info:
      name: List template cards
      type: http
    http:
      method: GET
      url: https://api.pdfmonkey.io/api/v1/document_template_cards
    docs: List templates as lightweight cards with pagination.