Convert
POST /v1/convert
Section titled “POST /v1/convert”Converts uploads and runs any post-processing fields. HTML goes to Fulgur
unless htmlEngine says libreoffice; everything else to LibreOffice.
Several files come back as a ZIP, or as one PDF with merge=true.
Needs credentials, if any are configured.
Request
Section titled “Request”multipart/form-data
| Field | Type | Required | Description |
|---|---|---|---|
files |
files | Yes | One or more documents. |
assets |
files | No | Images (PNG, JPEG, GIF, SVG), stylesheets and fonts an HTML page names by file name, as in <img src="logo.png">. Every stylesheet applies to the whole page. Nothing is fetched from anywhere else. |
htmlEngine |
string | No | What turns HTML into PDF: fulgur (default), a layout engine with no browser and no network, or libreoffice. |
landscape |
boolean | No | |
merge |
boolean | No | Merge several inputs into one PDF instead of returning a ZIP. |
nativePageRanges |
string | No | |
outputFilename |
string | No | |
password |
string | No | Opens a protected input. |
pdfa |
string | No | PDF/A level: PDF/A-1b, PDF/A-2b, PDF/A-3b, PDF/A-4. |
pdfua |
boolean | No | Export as PDF/UA. |
to |
string | No | Output format. Default pdf. |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
| 200 | The converted file, or a ZIP of them | File |
| 204 | Accepted; the result goes to the webhook | |
| 400 | The request is wrong | ErrorBody |
| 503 | An engine is unavailable or the request timed out | ErrorBody |