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 from built-in PDF.co files storage. For uploading files via API please check Files Upload section. If you are randomly getting a `Too Many Requests` or `Access Denied` error for your input URL, Please try to add `cache:` to enable built-in URL caching. You can also `encrypt data` for output files and `decrypt data` input files with user-controlled data encryption to learn more.
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 Output link expiration in minutes. The default is `60` (i.e. 60 minutes or 1 hour). After this delay generated output file(s) (if any) will be auto-removed from PDF.co 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 PDF.co built-in Files Storage instead.
async optional Runs processing asynchronously and returns `JobId` that you may use with `/job/check` to check the state of the processing (possible states: `working`, `failed`, `aborted` and `success`). Must be one of: `true`, or `false`.
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
}'