ConvertApi Logo

PDF to WEBP API

The API for converting PDF documents to WEBP images.

API Request:
Copy parameter's URL 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
Optional

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

Show all
Copy parameter's URL File
Required
Remove input

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

Show all
Copy parameter's URL StoreFile
Optional

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

Default: False

Show all
Copy parameter's URL FileName
Optional

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

Show all
Copy parameter's URL Timeout
Optional

Integer Conversion timeout in seconds.

Default: 900

Range: 10 .. 1200

Show all
Copy parameter's URL Async
Optional

Bool Run conversion job asynchronously.

Default: False

Show all
Copy parameter's URL JobId
Optional

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

Show all
Copy parameter's URL 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
Optional

String Sets the password to open protected documents.

Show all
Copy parameter's URL ImageResolutionH
Optional

Integer Set output image horizontal resolution in dpi.

Default: 150

Range: 1 .. 3000

Show all
Copy parameter's URL ImageResolutionV
Optional

Integer Set output image vertical resolution in dpi.

Default: 150

Range: 1 .. 3000

Show all
Copy parameter's URL ScaleImage
Optional

Bool Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.

Default: False

Show all
Copy parameter's URL ScaleProportions
Optional

Bool Constrain proportions when scaling the output image.

Default: True

Show all
Copy parameter's URL ScaleIfLarger
Optional

Bool Scaling only if the input image is larger than the output.

Default: False

Show all
Copy parameter's URL ImageHeight
Optional

Integer Image height in pixels.

Range: 10 .. 20000

Show all
Copy parameter's URL ImageWidth
Optional

Integer Image width in pixels.

Range: 10 .. 20000

Show all
Copy parameter's URL TextAntialiasing
Optional

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

Default: 1

Values: 0, 1, 2, 4

Show all
Copy parameter's URL GraphicsAntialiasing
Optional

Collection Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.

Default: 1

Values: 0, 1, 2, 4

Show all
Copy parameter's URL ImageInterpolation
Optional

Bool Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.

Default: False

Show all
Copy parameter's URL UseCIEColor
Optional

Bool Specifies whether the image parser should remap the device-dependent.

Default: False

Show all
Copy parameter's URL ImageQuality
Optional

Integer Set output image quality.

Default: 75

Range: 10 .. 100

Show all

Show advanced options

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