Docs

n8n

Use n8n-nodes-relaypdf when the workflow already lives in n8n. Default output is a binary PDF on field data for Gmail, Slack, and Drive. Office files go through Convert File, not POST /v1/pdf.

Install n8n-nodes-relaypdf, store the API key in a RelayPDF API credential, and pick an operation. Default output is binary field data for Gmail, Slack, and Drive. The npm README is the full operation table.

Install

Self-hosted: Settings → Community Nodes → n8n-nodes-relaypdf. n8n Cloud: search RelayPDF in the nodes panel after verification. Package: n8n-nodes-relaypdf on npm.

Credential

Create a RelayPDF API credential. Paste the key only — no Bearer prefix. Connection test calls GET /v1/account and is not billed. Default origin https://api.relaypdf.com.

Operations

Resource PDF covers create plus the toolbox. Convert File maps n8n binary to POST /v1/convert and sets sourceFilename from the incoming file name — do not base64-encode in a Code node.

ResourceOperationHTTP
PDFCreate (HTML / Markdown / URL / Template)POST /v1/pdf
PDFMerge / Extract / Protect / Unlock / BookmarksPOST /v1/pdf/*
PDFRaster / From images / Stamp / Rotate / Delete pages / CompressPOST /v1/pdf/*
PDFInfo / Text / Form fields / Fill formPOST /v1/pdf/info · /text · /form/*
ConvertConvert FilePOST /v1/convert
ImageCreatePOST /v1/images
BarcodeCreatePOST /v1/barcodes
ZipCreatePOST /v1/zip
TemplateList / GetGET /v1/templates
JobGetGET /v1/jobs/:id
AccountGetGET /v1/account (not billed)

Create a PDF

Resource PDF, Operation Create. Source is HTML, Markdown, URL, or Template. Template uses a published templateId and JSON templateData.

Template body the node sends
{
  "templateId": "invoice",
  "templateData": { "number": "INV-1042", "total": 1458 },
  "filename": "invoice.pdf"
}

Binary, URL, async

Binary (default) writes field data for attachments. URL returns a 24-hour download. Async can wait for the job or return pollUrl.

Convert and tools

Convert File maps n8n binary to POST /v1/convert. Merge, extract, protect, bookmarks, barcodes, and zip are first-class operations.

Trigger

RelayPDF Trigger receives dashboard webhooks. Paste the n8n URL into /dashboard/webhooks and the secret shown once into the trigger. Events are HMAC-signed.

HTTP Request fallback

If community nodes are disabled, POST https://api.relaypdf.com/v1/pdf with Header Auth Authorization Bearer pdf_live_… and Response Format File.