Link Search Menu Expand Document

20a. PDF to WEBP

Description: PDF to WeBP conversion. High quality rendering. Also works great for thumbnails generation and previews. GET or POST request.

Status Errors

200The request has succeeded
400bad input parameters
403not enough credits
405Timeout error. To process large documents or files please use asynchronous mode ( set async parameter to true) and then check the status using /job/check endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint /pdf/info


Sample Request:

!! ! Don’t forget to set x-api-key url param or http header param (preferred) to API key, get yours here


	"pages" : "",
	"password" : "",
	"url" : ""

Available Methods

[POST] /pdf/convert/to/webp

  • url required. URL to the source file. Supports links from Google Drive, Dropbox and from built-in files storage. For uploading files via API please check Files Upload section. If you are randomly getting Too Many Requests or Access Denied error for your input url, please try to add cache: to enable built-in url caching.
  • httpusername (optinal) - http auth user name if required to access source url.
  • httppassword (optinal) - http auth password if required to access source url.
  • pages optional. Comma-separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. Must be a String.
  • rect optional. Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. You can use PDF Viewer with coordinates to easily select and copy coordinates. Must be a String.

  • encrypt optional. Enable encryption for output file. Must be one of: true, false.
  • async optional. Runs processing asynchronously. Returns Use JobId that you may use with /job/check to check state of the processing (possible states: working, failed, aborted and success). Must be one of: true, false.
  • name optional. File name for generated output. Must be a String.
  • expiration (optional). Output link expiration in minutes. Default is 60 (i.e. 60 minutes or 1 hour). After this delay generated output file(s) (if any) will be auto-removed from temporary files storage. Max allowed expiration period depends on your current subscription plan. To store permanent input files (e.g. re-usable images, pdf, documents), please use built-in Files Storage instead.
  • profiles optional. Must be a String. You can set additional and extra options using this parameter that allows you to set custom configuration.

Example: you can control WebP image quality from 0..100 where 0 - lowest quality, smallest file size; 100 - best quality, largest file size). Default is 75 (better and smaller than JPEG with the same quality settings):

{ 'WEBPQuality': 75 }

Another example: turn on / off layers for rendering:

  "url": "",
  "pages": "0",
  "profiles": "{'RenderTextObjects': false, 'RenderVectorObjects': true,'RenderImageObjects': true}"

See profiles samples for examples.

  • Method: POST
  • URL: /v1/pdf/convert/to/webp

Query parameters

No query parameters accepted.

Body payload

  "url": "",
  "pages": "0"

Example responses

    "urls": [
    "pageCount": 1,
    "error": false,
    "status": 200,
    "name": "sample.png",
    "remainingCredits": 60716

Code Snippet

curl --location --request POST '' \
--header 'x-api-key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "url": "",
  "pages": "0"