PDFMonkey

https://pdfmonkey.io/docs
Admin
PDFMonkey is a document generation API that enables users to design templates with HTML/CSS or a...
Tokens:178,305
Snippets:1,718
Trust Score:9.1
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install gem with Bundler

Source: https://pdfmonkey.io/docs/integrations/ruby-sdk

Run `bundle` to install the gem and its dependencies.

```bash
$ bundle
```

--------------------------------

### Install pdfmonkey with npm

Source: https://pdfmonkey.io/docs/integrations/node-sdk

Install the PDFMonkey Node.js SDK using npm.

```bash
$ npm install pdfmonkey
```

--------------------------------

### Basic form field examples

Source: https://pdfmonkey.io/docs/code-templates/pdf-forms

Examples of text, checkbox, and dropdown markers with dimensions and options.

```html
[% data_form_field_text_w200_h30 %] [% data_form_field_checkbox_w20_h20 %] [%
data_form_field_dropdown_w250_h30_options[Option1,Option2,Option3] %]
```

--------------------------------

### Install PDFMonkey CLI with npm

Source: https://pdfmonkey.io/docs/code-templates/cli

Install the PDFMonkey CLI globally using npm. After installation, the `pdfmonkey` command becomes available in the terminal.

```bash
npm install -g @pdfmonkey/cli
```

--------------------------------

### Install gem directly

Source: https://pdfmonkey.io/docs/integrations/ruby-sdk

Install the gem directly using `gem install pdfmonkey`.

```bash
$ gem install pdfmonkey
```

--------------------------------

### Install pdfmonkey with pnpm, yarn, or bun

Source: https://pdfmonkey.io/docs/integrations/node-sdk

Install the PDFMonkey Node.js SDK using pnpm, yarn, or bun.

```bash
$ pnpm add pdfmonkey
```

```bash
$ yarn add pdfmonkey
```

```bash
$ bun add pdfmonkey
```

--------------------------------

### Get CLI help

Source: https://pdfmonkey.io/docs/code-templates/cli

Run `pdfmonkey help` to list available commands and general help.

```bash
pdfmonkey help
```

--------------------------------

### External resources example (HTML)

Source: https://pdfmonkey.io/docs/getting-started/external-resources

Shows external resources that require a paid plan: a remote script, stylesheet, and image.

```html
<!-- External resources -- require a paid plan -->
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
<link rel="stylesheet" href="https://example.com/styles.css" />
<img src="https://example.com/logo.png" />
```

--------------------------------

### Liquid template example with output tags, logic tags, and filters

Source: https://pdfmonkey.io/docs/code-templates/the-liquid-syntax

A complete Liquid template example for PDFMonkey that demonstrates output tags ({{ }}), logic tags ({% %}), and filters. It shows nested property access (client.fullName), the date filter with a format string, the times filter for multiplication, and the with_delimiter filter for formatting numbers with commas and decimals. The example also includes a for loop over lineItems and an if condition on client.isNewClient.

```liquid
<h1>Invoice #{{invoiceNumber}}</h1>
<p>Date: {{"now" | date: "%B %d, %Y"}}</p>
<p>Client: {{client.fullName}}</p>

<table>
  <tr>
    <th>Product</th>
    <th>Qty</th>
    <th>Price</th>
  </tr>

  {% for item in lineItems %}
    <tr>
      <td>{{item.product}}</td>
      <td>{{item.quantity}}</td>
      <td>{{item.price | times: item.quantity | with_delimiter, precision: 2}}</td>
    </tr>
  {% endfor %}
</table>

{% if client.isNewClient %}
  <p>Welcome aboard! Enjoy 10% off your next order.</p>
{% endif %}
```

--------------------------------

### Fetch document via API to get fresh download URL

Source: https://pdfmonkey.io/docs/troubleshooting/download-url-gives-403

Send a GET request to retrieve the document. The response includes a new `download_url` valid for 1 hour.

```bash
curl https://api.pdfmonkey.io/api/v1/documents/YOUR_DOCUMENT_ID \
  -H "Authorization: Bearer YOUR_SECRET_API_KEY"
```

--------------------------------

### JSON test data example

Source: https://pdfmonkey.io/docs/builder-templates/test-data

Example JSON object with top-level keys like name, company, date, items, and logo_url. These keys become variables available throughout the template.

```json
{
  "name": "Jane Smith",
  "company": "Acme Corp",
  "date": "2025-03-15",
  "items": [
    { "description": "Widget A", "quantity": 2, "price": 19.99 },
    { "description": "Widget B", "quantity": 1, "price": 49.99 }
  ],
  "logo_url": "https://example.com/logo.png"
}
```

--------------------------------

### Fetch template with Ruby

Source: https://pdfmonkey.io/docs/api/templates

Use the Pdfmonkey::Template.fetch method to retrieve a template. The example prints the identifier, body, and settings.

```ruby
template = Pdfmonkey::Template.fetch('8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9')

puts template.identifier
puts template.body
puts template.settings
```

--------------------------------

### Metadata JSON example

Source: https://pdfmonkey.io/docs/integrations/n8n

Example JSON metadata for the Generate Document operation. Metadata is attached to the document but not visible in the output; it can be retrieved later via Get Document or webhook triggers.

```json
{
  "orderId": "ORD-12345",
  "customerEmail": "john@example.com",
  "environment": "production"
}
```

--------------------------------

### 200 OK response for get template

Source: https://pdfmonkey.io/docs/api/templates

Example response body returned with a 200 OK status, containing the full document_template object.

```json
{
  "document_template": {
    "id": "8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9",
    "app_id": "3161c5e5-9966-4630-9b07-63f718092784",
    "identifier": "My Awesome Template",
    "edition_mode": "code",
    "output_type": "pdf",
    "body": "<p>Hello {{name}}</p>",
    "body_draft": "<p>Hello, <strong>{{name}}!</strong></p>",
    "scss_style": "p { color: green; }",
    "scss_style_draft": "p { color: purple; }",
    "sample_data": "{ \"name\": \"Peter Parker\" }",
    "sample_data_draft": "{ \"name\": \"Spider-Man\" }",
    "settings": { "...": "..." },
    "settings_draft": { "...": "..." },
    "pdf_engine_id": "5c709522-90db-4aea-b49f-15aeaa7180c7",
    "pdf_engine_draft_id": "5c709522-90db-4aea-b49f-15aeaa7180c7",
    "template_folder_id": null,
    "ttl": 86400,
    "created_at": "2050-01-02T03:04:05.678+02:00",
    "updated_at": "2050-01-02T03:04:05.678+02:00",
    "auth_token": "ZCsspcSZieyfdCUHYjKW1B9D8mnrz2ck",
    "checksum": "kfYsx6xzMx3JkYxLd4LW6YeU5rkcuTxQ",
    "preview_url": "https://preview.pdfmonkey.io/pdf/..."
  }
}
```

--------------------------------

### Example resource-based command with alias

Source: https://pdfmonkey.io/docs/code-templates/cli

Shows the resource-based command `pdfmonkey template init <template-id>` and its shorthand alias `pdfmonkey tpl init <template-id>`.

```bash
pdfmonkey template init <template-id>
# or using the shorthand alias
pdfmonkey tpl init <template-id>
```

--------------------------------

### Get a DocumentCard with Ruby

Source: https://pdfmonkey.io/docs/api/documents

Uses the Pdfmonkey::Document.fetch_card method to retrieve a DocumentCard. The example shows accessing the status and download_url attributes.

```ruby
card = Pdfmonkey::Document.fetch_card('a5e86d72-f5b7-43d4-a04e-8b7e08e6741c')

card.status       # => 'success'
card.download_url # => 'https://…'
```

--------------------------------

### Get a full Document with Ruby

Source: https://pdfmonkey.io/docs/api/documents

Uses the Pdfmonkey::Document.fetch method to retrieve a full Document. The example shows accessing the status and payload attributes.

```ruby
document = Pdfmonkey::Document.fetch('a5e86d72-f5b7-43d4-a04e-8b7e08e6741c')

document.status   # => 'success'
document.payload  # => '{"clientName":"Peter Parker",…}'
```

--------------------------------

### Inline resources example (HTML)

Source: https://pdfmonkey.io/docs/getting-started/external-resources

Shows inline resources that work on all plans: inline JavaScript, inline CSS, a data-uri image, and an inline SVG.

```html
<!-- Inline resources -- work on all plans -->
<script>
  console.log("inline JS");
</script>
<style>
  h1 {
    color: red;
  }
</style>
<img src="data:image/png;base64,iVBOR..." />
<svg xmlns="http://www.w3.org/2000/svg">...</svg>
```

--------------------------------

### date filter: current time with 'now'

Source: https://pdfmonkey.io/docs/code-templates/filters

Pass the special word 'now' (or 'today') to get the current time. Example shows formatting the current time.

```liquid
Last update: {{ "now" | date: "%Y-%m-%d %H:%M" }}
→ Last update: 2022-03-14 12:34
```

--------------------------------

### Test data JSON example

Source: https://pdfmonkey.io/docs/builder-templates/your-first-template

Define sample data for your template in the JSON editor. Fields like name, company, and items can be bound to text, images, visibility, and loops. The editor supports JSON comments (lines starting with //) which are stripped during parsing.

```json
{
  "name": "Jane Smith",
  "company": "Acme Corp",
  "items": [
    { "description": "Consulting", "amount": 1500 },
    { "description": "Development", "amount": 3000 }
  ]
}
```

--------------------------------

### Direct commands for templates

Source: https://pdfmonkey.io/docs/code-templates/cli

Direct shorthand commands for templates: `pdfmonkey init <template-id>` is the same as `pdfmonkey template init <template-id>`, and `pdfmonkey watch <path>` is the same as `pdfmonkey template watch <path>`.

```bash
pdfmonkey init <template-id>
# is the same as
pdfmonkey template init <template-id>

pdfmonkey watch <path>
# is the same as
pdfmonkey template watch <path>
```

--------------------------------

### Create per-tenant PDFMonkey client and generate document

Source: https://pdfmonkey.io/docs/integrations/node-sdk

Create a client per tenant for per-request credentials, then generate a document synchronously.

```ts
const tenantClient = new PDFMonkey(tenant.pdfmonkeyApiKey);

const card = await tenantClient.documents.generateSync({
  document_template_id: "b13ebd75-…",
  payload: { name: "John Doe" },
});
```

--------------------------------

### Initialize a PDFMonkey template with template ID and destination folder

Source: https://pdfmonkey.io/docs/code-templates/cli

Specify both the template ID and the destination folder as arguments. You will be prompted to choose the destination folder if it is not provided.

```bash
pdfmonkey template init <template-id> <destination-folder>
```

--------------------------------

### Error field example with Continue On Fail

Source: https://pdfmonkey.io/docs/integrations/n8n

Example JSON error field returned when Continue On Fail is enabled.

```json
{
  "error": "PDFMonkey could not generate document <id>: <failure_cause>"
}
```

--------------------------------

### Checkbox example in template

Source: https://pdfmonkey.io/docs/code-templates/pdf-forms

Example of using checkbox markers inside HTML paragraphs with ballot box characters.

```html
<p>☐ I accept the terms [% data_form_field_checkbox_accept_w20_h20 %]</p>
<p>☐ Subscribe to newsletter [% data_form_field_checkbox_newsletter_w20_h20 %]</p>
```

--------------------------------

### Embed preview in iframe (FAQ)

Source: https://pdfmonkey.io/docs/generating-documents/embedding-a-preview

A minimal iframe example from the FAQ section, using the preview_url field to embed the document preview.

```html
<iframe src="DOCUMENT_PREVIEW_URL"></iframe>
```

--------------------------------

### Google Sheets node output example

Source: https://pdfmonkey.io/docs/integrations/n8n

Example JSON output from a Google Sheets node, showing an array of product data.

```json
[
  { "product": "Widget", "qty": 5, "price": 10 },
  { "product": "Gadget", "qty": 2, "price": 25 }
]
```

--------------------------------

### 201 Created response (trimmed)

Source: https://pdfmonkey.io/docs/generating-documents/api-pdf-generation

Example response from creating a document. Shows the document id, status 'pending', and download_url null. The id is needed to check generation status.

```json
{
  "document": {
    "id": "a5e86d72-f5b7-43d4-a04e-8b7e08e6741c",
    "status": "pending",
    "download_url": null,
    ...
  }
}
```

--------------------------------

### Configure credentials manually

Source: https://pdfmonkey.io/docs/integrations/ruby-sdk

Configure the SDK with your private key explicitly in your application.

```ruby
Pdfmonkey.configure do |config|
  config.private_key = 'j39ckj4…'
end
```

--------------------------------

### Nested payload example

Source: https://pdfmonkey.io/docs/troubleshooting/data-not-showing

Example payload with nested client object and address. Use dot notation in templates to access nested values.

```json
{
  "client": {
    "name": "Jane Doe",
    "address": {
      "city": "Paris"
    }
  }
}
```

--------------------------------

### Stripe invoice line items example

Source: https://pdfmonkey.io/docs/integrations/zapier

Example of line items from a Stripe invoice, showing product names, unit prices, quantities, and totals.

```text
Delicious waffle         3.50€      x12      = 42.00€
Perfectly round donut    4.99€      x5       = 24.95€
TOTAL                                          66.95€
```

--------------------------------

### Initialize a snippet and open in editor

Source: https://pdfmonkey.io/docs/code-templates/cli

Initializes a snippet and opens the created file in your default editor using the -e or --edit option.

```bash
pdfmonkey snippet init <snippet-id> -e
```

--------------------------------

### Create a document with Ruby (Pdfmonkey::Document.generate!)

Source: https://pdfmonkey.io/docs/generating-documents/api-pdf-generation

Uses the Pdfmonkey Ruby gem's generate! method, which waits for the PDF to be ready before returning. The resulting document status is 'success' and download_url is available.

```ruby
# generate! waits for the PDF to be ready before returning
document = Pdfmonkey::Document.generate!(
  document_template_id: 'YOUR-TEMPLATE-ID',
  payload: { name: 'Jane Doe' }
)

document.status       # => 'success'
document.download_url # => 'https://…'
```

--------------------------------

### Get Document - Document ID

Source: https://pdfmonkey.io/docs/integrations/n8n

Required field for the Get Document operation. Retrieves information about a previously generated document using the document ID.

```plaintext
Document ID: {{ $json.documentId }}
```

--------------------------------

### Create and poll a document with curl

Source: https://pdfmonkey.io/docs/api/documents

Shows the asynchronous workflow: create a document with status 'pending' to queue generation, then poll the document card until status becomes 'success' and read the download_url. Requires a Bearer token and a template ID.

```bash
# 1. Create a document and queue it for generation
curl https://api.pdfmonkey.io/api/v1/documents \
  -X POST \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "document": {
      "document_template_id": "YOUR_TEMPLATE_ID",
      "status": "pending",
      "payload": { "name": "Jane Doe" }
    }
  }'
# Returns a document with "status": "pending" and "download_url": null

# 2. Poll the document status until it reaches "success"
curl -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  https://api.pdfmonkey.io/api/v1/document_cards/DOCUMENT_ID
# Once status is "success", read the download_url from the response
```

--------------------------------

### Example document payload (JSON)

Source: https://pdfmonkey.io/docs/code-templates/custom-javascript

Example payload with a movie object containing title and year. Used to demonstrate accessing document data via $docPayload.

```json
{
  "movie": {
    "title": "12 Monkeys",
    "year": 1995
  }
}
```

--------------------------------

### Dotted guide line technique

Source: https://pdfmonkey.io/docs/code-templates/pdf-forms

Technique to create a dotted guide line under a borderless field: use white marker text with noborder and a dotted bottom border.

```html
<p style="color: white;">[% data_form_field_text_email_w350_h30_noborder_email %]</p>
<p style="border-bottom: 1px dotted #999; width: 350px;"></p>
```

--------------------------------

### workspaces.get

Source: https://pdfmonkey.io/docs/integrations/node-sdk

Fetches a workspace.

```APIDOC
## workspaces.get

### Description
Fetches a workspace.

### Method
GET

### Endpoint
`/workspaces/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The workspace identifier.

### Response
- **identifier** (string) - The workspace identifier.

### Example
```ts
const workspace = await client.workspaces.get("workspace-id");
workspace.identifier; // => 'my-app'
```
```

--------------------------------

### Custom filename examples

Source: https://pdfmonkey.io/docs/integrations/n8n

Example custom filenames using n8n expressions. Use these in the Custom Filename option under Additional Options. Avoid slashes and special characters as warned.

```plaintext
Invoice-{{ $json.invoiceNumber }}.pdf
Report-{{ $now.format('YYYY-MM-DD') }}.pdf
{{ $json.customerName }}-Contract.pdf
```

--------------------------------

### Initialize a PDFMonkey template

Source: https://pdfmonkey.io/docs/code-templates/cli

Run `pdfmonkey template init` to start editing a PDFMonkey template. The command prompts you to select a workspace and find the template you want to edit.

```bash
pdfmonkey template init
```

--------------------------------

### Template.fetch

Source: https://pdfmonkey.io/docs/integrations/ruby-sdk

Fetches a full template including its body and settings. Use `list_cards` when you only need metadata.

```APIDOC
## Template.fetch

### Description
Fetches a full template including its body and settings. Use `list_cards` when you only need metadata.

### Method
fetch

### Endpoint
Pdfmonkey::Template.fetch(id)

### Parameters
- **id** (string) - Required - The template identifier.

### Response
Returns a Template object with attributes: `identifier`, `body`, `body_draft`.

### Example
```ruby
template = Pdfmonkey::Template.fetch('b13ebd75-d290-409b-9cac-8f597ae3e785')
template.identifier # => 'my-invoice'
template.body       # => '<h1>Invoice</h1>…'  (published version)
template.body_draft # => '<h1>Invoice v2</h1>…'  (draft version)
```
```

--------------------------------

### JSON Special Characters: Wrong and Correct

Source: https://pdfmonkey.io/docs/integrations/n8n

Shows how to escape double quotes inside JSON string values. The wrong example has unescaped quotes that break JSON, the correct example escapes them.

```json
// Wrong - unescaped quotes break JSON
{ "html": "<div class=\"test\">Hello</div>" }

// Correct - escaped inner quotes
{ "html": "<div class=\"test\">Hello</div>" }
```

--------------------------------

### Fetch a document card (recommended)

Source: https://pdfmonkey.io/docs/integrations/node-sdk

Fetches a lightweight document card using client.documentCards.get. Recommended over documents.get because it avoids loading the full payload.

```TypeScript
const card = await client.documentCards.get(
  "76bebeb9-9eb1-481a-bc3c-faf43dc3ac81",
);
```

--------------------------------

### JSON Payload example

Source: https://pdfmonkey.io/docs/integrations/n8n

Example JSON payload for the Generate Document operation, showing nested customer data and an items array. Use this structure when your template expects complex or nested data.

```json
{
  "customer": {
    "name": "Acme Inc.",
    "email": "contact@acme.com",
    "address": {
      "street": "123 Main St",
      "city": "New York",
      "zip": "10001"
    }
  },
  "items": [
    {
      "product": "Widget",
      "quantity": 5,
      "price": 10.99
    },
    {
      "product": "Gadget",
      "quantity": 2,
      "price": 24.99
    }
  ],
  "total": 104.93
}
```

--------------------------------

### Create a document with Node.js (fetch)

Source: https://pdfmonkey.io/docs/generating-documents/api-pdf-generation

Uses the fetch API to POST to /api/v1/documents with status 'pending'. Logs the returned document object.

```javascript
const response = await fetch("https://api.pdfmonkey.io/api/v1/documents", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    document: {
      document_template_id: "YOUR-TEMPLATE-ID",
      status: "pending",
      payload: { name: "Jane Doe" },
    },
  }),
});

const data = await response.json();
console.log(data.document);
```
Tokens:
Raw