PDF to WEBP

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

Status Errors

Code	Description
`200`	The request has succeeded
`400`	bad input parameters
`401`	unauthorized
`403`	not enough credits
`405`	Timeout 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 a 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`

Example

Sample Request:

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

POST

{
	"pages" : "",
	"password" : "",
	"url" : "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-image/sample.pdf"
}

Available Methods

[POST] /pdf/convert/to/webp

[POST] /pdf/convert/to/webp

Attributes
url required URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. To upload files via API, Check out the Files Upload section. Note: If you experience intermittent `Too Many Requests` or `Access Denied` errors, please try to add `cache:` to enable built-in URL caching. (e.g `cache:https://example.com/file1.pdf`) For data security, you have the option to encrypt output files and decrypt input files. Learn more about user-controlled data encryption.
httpusername optional HTTP auth user name if required to access source `url`.
httppassword optional 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 the 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, The input must be in string format.
rect optional Defines coordinates for extraction, e.g. `51.8, 114.8, 235.5, 204.0`. Use PDF.co PDF Edit Add Helper to get or measure pdf coordinates. The input must be in string format.
inline optional Must be one of: `true` to return data as inline or `false` to return a link to the output file (default).
name optional File name for the generated output, The input must be in string format.
expiration optional Set the expiration time for the output link in minutes (`default is 60` i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan. Learn more To store permanent input files (e.g. re-usable images, pdf templates, documents), Consider using PDF.co built-in Files Storage.
async optional Set `async` to `true` for long processes to run in the background, API will then return a `jobId` which you can use with `/job/check` endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
profiles optional You can set additional and extra options using this parameter that allows you to set custom configurations, The input must be in string format.

Example: you can control WebP image quality from 0..100 where 0 - is the lowest quality, smallest file size; 100 - is the 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": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-image/sample.pdf",
  "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": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-image/sample.pdf",
  "inline": true,
  "pages": "0-",
  "async": false
}

Example responses

/pdf/convert/to/webp

{
    "urls": [
        "https://pdf-temp-files.s3.amazonaws.com/c9f65eaac1e740cf9aadc2f102e571ec/sample.webp"
    ],
    "pageCount": 1,
    "error": false,
    "status": 200,
    "name": "sample.png",
    "remainingCredits": 60716
}

Code Snippet

CURL

curl --location --request POST 'https://api.pdf.co/v1/pdf/convert/to/webp' \
--header 'x-api-key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-image/sample.pdf",
  "inline": true,
  "pages": "0-",
  "async": false
}'