Skip to main content
The PDFEngines class uses Gotenberg’s PDF Engines routes to manipulate existing PDFs. It does not create PDFs from HTML or URLs; use the Chromium or LibreOffice routes for that. Merge order is alphanumeric by filename (same as Gotenberg).

​
Operations

MethodDescription
convertConvert PDFs to PDF/A and/or PDF/UA
mergeMerge multiple PDFs into one
watermarkApply watermark overlays behind page content
stampApply stamp overlays on top of page content
readMetadataRead metadata from PDFs
writeMetadataWrite metadata to PDFs
readBookmarksRead PDF bookmarks (document outline)
writeBookmarksWrite PDF bookmarks (document outline)
splitSplit PDFs by page ranges or intervals
rotateRotate pages of existing PDFs
flattenFlatten forms and annotations
generateHelper to write a buffer to a file (e.g. __generated__/out.pdf)
All methods accept files as an array of paths or { data, ext } objects. See the individual pages for parameters and examples.

​
Next pages