PDF engines overview - Chromiumly

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

Method	Description
`convert`	Convert PDFs to PDF/A and/or PDF/UA
`merge`	Merge multiple PDFs into one
`watermark`	Apply watermark overlays behind page content
`stamp`	Apply stamp overlays on top of page content
`readMetadata`	Read metadata from PDFs
`writeMetadata`	Write metadata to PDFs
`readBookmarks`	Read PDF bookmarks (document outline)
`writeBookmarks`	Write PDF bookmarks (document outline)
`split`	Split PDFs by page ranges or intervals
`rotate`	Rotate pages of existing PDFs
`flatten`	Flatten forms and annotations
`encrypt`	Encrypt existing PDFs with user/owner passwords and permissions
`embed`	Attach files to existing PDFs
`facturX`	Turn existing PDFs into Factur-X / ZUGFeRD e-invoices
`generate`	Helper 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. Every method also accepts the cross-cutting downloadFrom, webhook, outputFilename, and trace parameters — see Request tracing. See the individual pages for parameters and examples.

Next pages

Convert — PDF/A and PDF/UA
Merge
Watermark and stamp
Metadata — read/write metadata and bookmarks
Split
Rotate
Flatten
Encrypt — dedicated encryption route
Embed — dedicated attachment route
Factur-X — dedicated e-invoice route