Link Search Menu Expand Document

PDF Compress and Optimize

Optimize PDF document to reduce its size.

Available Methods

[POST] /pdf/optimize

url required
URL to the source file. Supports links from Google Drive, Dropbox, and 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:

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.
name optional
File name for the generated output. Must be in a “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 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 built-in Files Storage.
password optional
Password of PDF file. Must be in a “string” format.
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
Use this parameter to set additional configurations for fine-tuning and extra options. Must be in a “string” format. You can adjust PDF compression and optimization configuration using this parameter. Check this KB article for compression configuration details or Explore knowledgebase for all profile examples.
  • Method: POST
  • URL: /v1/pdf/optimize

Query parameters

No query parameters accepted.

Body payload

    "url": "",
    "name": "output.pdf",
    "profiles": "{ 'ImageOptimizationFormat': 'JPEG', 'JPEGQuality': 25, 'ResampleImages': true, 'ResamplingResolution': 120, 'GrayscaleImages': false }",
    "async": false

Example responses

    "url": "",
    "fileSize": 798621,
    "pageCount": 5,
    "error": false,
    "status": 200,
    "name": "sample-compressed.pdf",
    "credits": 105,
    "duration": 2886,
    "remainingCredits": 98256037

Code Snippet

curl --location --request POST '' \
--header 'Content-Type: application/json' \
--header 'x-api-key: ' \
--data-raw '{
    "url": "",
    "name": "output.pdf",
    "profiles": "{ '\''ImageOptimizationFormat'\'': '\''JPEG'\'', '\''JPEGQuality'\'': 25, '\''ResampleImages'\'': true, '\''ResamplingResolution'\'': 120, '\''GrayscaleImages'\'': false }",
    "async": false