ConvertApi Logo

PDF to WEBP API

The API for converting PDF documents to WEBP images.

API Request:
Copy parameter's URL Secret Secret
Optional

String Authentication secret must be provided as a query parameter. If omitted, token must be provided.

Show all
Copy parameter's URL Token Token
Optional

String Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Show all
Copy parameter's URL File File
Required

File File to be converted. Value can be URL or file content.

Show all
Copy parameter's URL StoreFile Store file
Optional

Bool Store converted file on our secure server and provides download URL.

Default: False

Show all
Copy parameter's URL FileName File name
Optional

String Converted output file name without extension. The extension will be added automatically.

Show all
Copy parameter's URL Timeout Timeout
Optional

Integer Conversion timeout in seconds.

Default: 900

Range: 10 .. 1200

Show all
Copy parameter's URL Async Asynchronous
Optional

Bool Run conversion job asynchronously.

Default: False

Show all
Copy parameter's URL JobId Job ID
Optional

String Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously.

Show all
Copy parameter's URL WebHook WebHook
Optional

String Set WebHook URL to call after asynchronous conversion is finished. Async parameter must be enabled.

Show all
Copy parameter's URL DocumentPassword Document Password
Optional

String Sets the password to open protected documents.

Show all
Copy parameter's URL PageRange Page Range
Optional

String Set page range. Example 1-10 or 1,2,5.

Default: 1-2000

Show all
Copy parameter's URL ImageResolution Image resolution
Optional

Integer Set output image resolution in dpi.

Default: 200

Range: 10 .. 800

Show all
Copy parameter's URL ScaleProportions Scale proportions
Optional

Bool Constrain proportions when scaling the output image.

Default: True

Show all
Copy parameter's URL PreserveResolution Preserve resolution
Optional

Bool Preserve resolution when scaling. Used together with ImageHeight and ImageWidth properties.

Default: False

Show all
Copy parameter's URL ImageHeight Image height
Optional

Integer Image height in pixels. If PreserveResolution property is set, render with a maximum height allowed by resolution.

Range: 10 .. 20000

Show all
Copy parameter's URL ImageWidth Image width
Optional

Integer Image width in pixels. If PreserveResolution property is set, render with a maximum width allowed by resolution.

Range: 10 .. 20000

Show all
Copy parameter's URL ImageAntialiasing Image antialiasing
Optional

Integer Control the use of text and graphics subsample antialiasing. The subsampling box size should be 8 bits for optimum text antialiasing, but smaller values can be used for faster rendering.

Default: 8

Range: 0 .. 8

Show all
Copy parameter's URL ImageQuality Output image quality
Optional

Integer Set output image quality.

Default: 100

Range: 10 .. 100

Show all

Developer mode

Snippets are autogenerated according to converter parameter choices above. Please select file in "File" or "Files" parameter before using code snippets.

Code snippet is using ConvertAPI JavaScript Client

Code snippet is using ConvertAPI Node.js Client

Code snippet is using ConvertAPI PHP Client

Code snippet is using ConvertAPI Java Client

Code snippet is using ConvertAPI C# Client

Code snippet is using ConvertAPI Ruby Client

Code snippet is using ConvertAPI Python Client

Code snippet is using ConvertAPI Go Client

Code snippet is using command line utility program

For conversions with the multiple file result please refer to the example