Package Information
Documentation
n8n-nodes-imaginepdf
An n8n community node that generates a PDF from one of your
ImaginePDF designs. Drop it into any workflow to turn an upstream event — a
new row, a webhook, a form submission, a payment — into a finished, on-brand PDF,
then attach it to an email, upload it to Drive, or write it to disk.
The npm package is
n8n-nodes-imaginepdf(n8n requires then8n-nodes-
prefix); the repo folder matches the package name.
What it does
| Node | Operation | Description |
|---|---|---|
| ImaginePDF | Generate PDF | Render a PDF from a design with your field values. Costs 1 credit. |
The node outputs the PDF as binary data (default field data) plus JSON
metadata (downloadUrl, filename, expiresIn, status), so the file flows
straight into Google Drive, Gmail, or Write Binary File nodes.
Image upload, batch generation, and design search are not in this version.
Installation
Community node, installable from the n8n UI: Settings → Community Nodes →
Install → n8n-nodes-imaginepdf. (Self-hosted n8n only; verified community
nodes can also be enabled on Cloud per your plan.)
Credentials
ImaginePDF uses a workspace API key (X-API-Key); the workspace is resolved
from the key.
- Sign in at imaginepdf.com → Settings → API Keys
(setup details: docs.imaginepdf.com/api/authentication). - Create a key (starts with
pc_live_) and copy it (shown once). - In n8n, create an ImaginePDF API credential and paste the key. n8n verifies
it with a lightweightGET /designs?limit=1.
Using the node
- Select Generate PDF.
- Pick a Design from the dropdown (loaded from your workspace).
- Add Field Values — key each by the variable name bound in the design
(e.g.recipient_name), mapped from earlier nodes. For image fields, pass anuploads:<id>/assets:<id>reference, not raw image data. - Optionally change Put Output File in Field (default
data). - Use the output binary file downstream, or the
downloadUrl(presigned, ~1h).
Each generated PDF costs 1 credit.
Local development
Built with the @n8n/node-cli:
cd n8n-nodes-imaginepdf
npm install
npm run lint # n8n node linter
npm run build # compile + bundle icons to dist/
npm run dev # run a local n8n with this node linked, for live testing
Then create the credential, build a workflow, and run the node against a real
design to confirm the binary PDF output.
To test the published tarball as a real user would (rather than the linked dev
build), install it into a clean n8n instance:
N8N_USER_FOLDER=~/.n8n-verify npx n8n
Then Settings → Community Nodes → Install → n8n-nodes-imaginepdf.
Publishing
npm run release (via n8n-node release) publishes to npm with provenance
attestation — required for community nodes since May 1, 2026. Submit for n8n
verification per the
community-nodes docs.
Keep real API keys out of git.
Notes
- Base URL:
https://api.imaginepdf.com/api/v1. The node is a thin caller — all
rendering, credits, and design logic live in the ImaginePDF API. - License: MIT.