PDF tools
Routes that work on PDFs you already have. Most of these steps can also run as part of a conversion, in the same request.
Routes
| Page | Route | Answer |
|---|---|---|
| Merge | /v1/pdf/merge | one PDF |
| Split | /v1/pdf/split | a ZIP of parts, or one PDF |
| PDF/A and PDF/UA | /v1/pdf/pdfa | the PDFs |
| Encrypt | /v1/pdf/encrypt | the PDFs |
| Watermark and stamp | /v1/pdf/watermark, /stamp | the PDFs |
| Rotate | /v1/pdf/rotate | the PDFs |
| Flatten | /v1/pdf/flatten | the PDFs |
| Compress | /v1/pdf/optimize | the PDFs |
| Metadata | /v1/pdf/metadata/read, /write | JSON, or the PDFs |
| Bookmarks | /v1/pdf/bookmarks/read, /write | JSON, or the PDFs |
| Attachments | /v1/pdf/attachments | the PDFs |
| Factur-X | /v1/pdf/factur-x | the PDFs |
All are POST with the PDFs as file parts. “The PDFs” means one PDF for one file sent, and a ZIP for several, each
file keeping its name. Every successful request counts as one PDF on your plan, however many files it handles.
Options on conversion routes
The HTML, URL, Markdown and Office routes, and merge and split, also take these fields. They work on the PDF that was just made, so a finished, archived, protected document is still one request (and one PDF on your plan):
| Field | Type | Default | What it does |
|---|---|---|---|
splitMode, splitSpan, splitUnify | string, string, boolean | – | Split the result. See Split. |
watermarkSource, watermarkExpression, watermarkPages, watermarkOptions | strings | – | Draw a watermark behind the content. See Watermark and stamp. |
stampSource, stampExpression, stampPages, stampOptions | strings | – | Draw a stamp over the content. See Watermark and stamp. |
rotateAngle, rotatePages | integer, string | – | Turn pages by 90, 180 or 270 degrees. See Rotate. |
optimizeImages, imageQuality | boolean, integer | false, 80 | Re-compress the images to make the file smaller. See Compress. |
pdfa, pdfua | string, boolean | – | Make a PDF/A or PDF/UA file. See PDF/A and PDF/UA. |
metadata | JSON object | – | Title, author and other document properties. See Metadata. |
embeds, embedsMetadata | files, JSON object | – | Attach files to the PDF. See Attachments. |
facturxXml, facturxConformanceLevel, ... | file, strings | – | Make an e-invoice. See Factur-X. |
userPassword, ownerPassword, allow... | strings, booleans | – | Protect the PDF with a password and limit what readers may do. See Encrypt. |
Merge, split and the Office route also take flatten=true.
They run in a fixed order: split, watermark, stamp, rotate, flatten, compress images, PDF/A or PDF/UA, metadata, attachments, Factur-X, and encryption last. Two rules follow from the standards:
- PDF/A cannot be encrypted.
pdfatogether withuserPasswordis refused with400. - Only PDF/A-3 may carry attachments.
embedswithPDF/A-1borPDF/A-2bis refused with400.