v1

latestOpenAPI 3.0.42026-07-13161871.7 KB

Pdf

Generate pdf file from url using the excellent tool wkhtmltopdf.

post/api/pdf/wkhtmltopdf

Headers

X-Api-Versionstring

Request body

urlstring nullable

The url to generate pdf from. Url has precedence over HtmlBase64String value if both are set.

htmlBase64Stringstring nullable

Base64 encoded string with html. If property Url is set, it will be used, not HtmlBase64String.

resourcesobject nullable

This is a set of key-value pairs of digital resources like images that is referenced in the HtmlBase64String document. It uses the filename including relative path as key and the data is provided as a Base64 encoded string.

wkHtmlToPdfArgumentsobject nullable

Command line arguments passed to wkhtmltopdf. Invalid arguments will be ignored. Invalid arguments are "manpage", "help", "H", "h", "extended-help", "htmldoc", "readme", "license", "read-args-from-stdin", "readme", "version", "V", "debug-javascript", "no-debug-javascript", "enable-local-file-access", "disable-local-file-access", "allow".

Response

Returns the newly created pdf file. Either the file directly or serialized as Json if Accept-header is set to application/json

errorMessagestring nullable

If any error occurs the message will be displayed in here

pdfFileBase64Stringstring nullable

The Base64 encoded string that is the pdf file.