Pdf To Image request

POST https://api.pdfbroker.io/api/pdf/pdftoimage

This api request is for producing images of pdf document pages. Perfect for previewing documents in a web context or showing documents when a pdf reader is not available

Options

These are the options available when generating images from your pdf documents

Option	Description
pageNumber	Set which page of pdf document to render image from. Default is 1
imageFormat	Valid options are "image/jpeg", "image/png" or "image/gif". Default is "image/png"
horizontalResolution	Set the horizontal resolution, default is 96 dpi
verticalResolution	Set the vertical resolution, default is 96 dpi
width	Set the width of the output image, default value is width of source document. To scale width, and keeping proportions, do not set height
height	Set the height of the output image, default value is height of source document. To scale height, and keeping proportions, do not set width
transparent	Boolean to keep the background of the image transparent. This setting has no effect in JPEG-files, since transparency is not supported in the JPEG format. Default value is false.
jpegQuality	Sets the quality of jpeg images, range 0 to 100, default is 75
pngCompressionLevel	Sets the png compression level, range 1 - 9, default is 6

Example of generating jpeg image of the first page of the attached pdf document.

{
    "pdfFileBase64String": "PD94bWwgdmVyc2lvbj0iMS4wI...shortened for readability",
    "options": {
        "pageNumber": 1,
        "imageFormat": "image/jpeg",
        "horizontalResolution": 96.0,
        "verticalResolution": 96.0,                
        "jpegQuality": 90
    }
}

Example of request with data formatted as application/form-data, generating jpeg image of the first page of the attached pdf document.

----------------------------420442405519228210203448
Content-Disposition: form-data; name="pdfdocument"; filename="AS1F04-produktblad-gt50ax.pdf"
Content-Type: application/pdf

<PDF file content removed for readability>

----------------------------420442405519228210203448
 Content-Disposition: form-data; name="options"

{
    "pageNumber": 1,
    "imageFormat": "image/jpeg",
    "horizontalResolution": 96.0,
    "verticalResolution": 96.0,                
    "jpegQuality": 90
}
----------------------------420442405519228210203448--

Checkout Swagger documentation

Pdf To Image request

Options

Example

Feedback