PDF 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 from built-in PDF.co files storage. For uploading files via API please check Files Upload section. If you are randomly gettingToo Many Requests
orAccess Denied
error for your input url, please try to addcache:
to enable built-in url caching. You can also encrypt data for output files and decrypt data input files with user-controlled data encryption (uses strongAES
encryption with your own keys). Click here to learn more.httpusername
(optional) - http auth user name if required to access sourceurl
.httppassword
(optional) - http auth password if required to access sourceurl
.name
optional. File name for generated output. Must be a String.expiration
(optional). Output link expiration in minutes. Default is60
(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.password
optional. Password of PDF file. Must be a String.async
optional. Runs processing asynchronously. ReturnsJobId
that you may use with/job/check
to check state of the background job (possible states:working
,failed
,aborted
andsuccess
). Must be one of:true
,false
.profiles
optional. Must be a String. Use this parameter to set additional configuration for fine tuning and extra options. Explore PDF.co knowledgebase for profile examples.- Method: POST
- URL: /v1/pdf/optimize
Query parameters
No query parameters accepted.
Body payload
{
"url": "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-optimize/sample.pdf",
"async": false
}
Example responses
/pdf/optimize
{
"url": "https://pdf-temp-files.s3.amazonaws.com/c3bde960dcc54bcebc14a72ab1521fa9/result-compressed.pdf",
"fileSize": 798621,
"pageCount": 5,
"error": false,
"status": 200,
"name": "result-compressed.pdf",
"remainingCredits": 59877
}
Code Snippet
CURL
curl --location --request POST 'https://api.pdf.co/v1/pdf/optimize' \
--header 'Content-Type: application/json' \
--header 'x-api-key: ' \
--data-raw '{
"url": "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-optimize/sample.pdf",
"async": false
}'
Samples
- C# - Optimize PDF From URL
- C# - Optimize PDF From URL Asynchronously
- C# - Optimize PDF From Uploaded File
- Java - Optimize PDF From URL
- Java - Optimize PDF From Uploaded File
- JavaScript - Optimize PDF From URL (Node.js)
- JavaScript - Optimize PDF From URL (Node.js) - Async API
- JavaScript - Optimize PDF From Uploaded File (Node.js)
- JavaScript - Optimize PDF From Uploaded File (Node.js) - Async API
- PHP - Optimize PDF Asynchronously
- PHP - Optimize PDF From Uploaded File
- PowerShell - Optimize PDF From URL
- PowerShell - Optimize PDF From URL Asynchronously
- PowerShell - Optimize PDF From Uploaded File
- Python - Optimize PDF From URL
- Python - Optimize PDF From URL Asynchronously
- Python - Optimize PDF From Uploaded File
- Salesforce - Compress PDF Document
- Salesforce - Compress PDF Document From Uploaded File
- VB.NET - Optimize PDF From URL
- VB.NET - Optimize PDF From URL Asynchronously
- VB.NET - Optimize PDF From Uploaded File
- cURL - PDF Optimize
Copyright © 2016 - 2023 PDF.co