Link Search Menu Expand Document


Explore Samples

Description: PDF to high quality TIFF images conversion. High quality rendering. Also works great for thumbnail 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 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


Sample Request:

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


	"name" : "result.tiff",
	"pages" : "",
	"password" : "",
	"url" : ""

Available Methods

[POST] /pdf/convert/to/tiff

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 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 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 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, The input must be in string format.
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
Use this parameter to set additional configurations for fine-tuning and extra options, The input must be in string format. For example, to 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/tiff

Query parameters

No query parameters accepted.

Body payload

    "url": "",
    "inline": true,
    "pages": "0-",
    "async": false

Example responses

    "url": "",
    "pageCount": 2,
    "error": false,
    "status": 200,
    "name": "result.tiff",
    "remainingCredits": 98162

Code Snippet

curl --location --request POST '' \
--header 'x-api-key: ' \
--data-raw '{
    "url": "",
    "inline": true,
    "pages": "0-",
    "async": false