Embed files in PDFs

PDFEngines.embed

Attaches files to existing PDFs directly using Gotenberg’s embed route, without going through a conversion:

import { PDFEngines } from "chromiumly";

const embedded = await PDFEngines.embed({
  files: ["path/to/document.pdf"],
  embeds: ["path/to/invoice.xml", "path/to/logo.png"],
  embedsMetadata: {
    "invoice.xml": { mimeType: "text/xml", relationship: "Data" },
  },
});

files — PDFs to embed into.
embeds — Files to attach inside the PDF.
embedsMetadata — Per-attachment metadata keyed by filename, for PDF/A-3 and Factur-X compliance.

downloadFrom, webhook, outputFilename, and trace are also accepted — see Request tracing.

Embedding on convert routes

Chromium converters and LibreOffice.convert() also accept embeds and embedsMetadata directly, so you can attach files in the same request that generates the PDF. See Embedding files for the full cross-cutting reference and the embedsMetadata shape.

Encrypt PDFs Factur-X / ZUGFeRD

Getting started

Chromium

LibreOffice

PDF engines

Advanced

PDFEngines.embed

Embedding on convert routes

​PDFEngines.embed

​Embedding on convert routes

PDFEngines.embed

Embedding on convert routes