PDF Optimize (DEPRECATED)
Optimize a PDF file to reduce its size.
POST /v1/pdf/optimize
DEPRECATED method - Please use PDF Compress
Not as powerful as compression, this function can optimize input PDF files up to 13 times smaller in file size by optimizing images and objects inside.
Attributes
Attributes are case-sensitive and should be inside JSON for POST request. for example: { "url": "https://example.com/file1.pdf" }
Attribute | Type | Required | Default | Description |
---|---|---|---|---|
url | string | Yes | - | URL to the source file url attribute |
callback | string | No | - | The callback URL (or Webhook) used to receive the POST data. see Webhooks & Callbacks. This is only applicable when async is set to true . |
httpusername | string | No | - | HTTP auth user name if required to access source URL. |
httppassword | string | No | - | HTTP auth password if required to access source URL. |
name | string | No | - | File name for the generated output, the input must be in string format. |
expiration | integer | No | 60 | Set the expiration time for the output link in minutes. 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. To store permanent input files (e.g. re-usable images, pdf templates, documents) consider using PDF.co Built-In Files Storage. |
password | string | No | - | Password for the PDF file. |
async | boolean | No | false | Set async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint. Also see Webhooks & Callbacks |
profiles | object | No | - | See Profiles for more information. |
ImageOptimizationFormat | string | No | JPEG | Controls image compression format. See profiles.ImageOptimizationFormat for more information. |
JPEGQuality | integer | No | 25 | Controls JPEG compression quality. See profiles.JPEGQuality for more information. |
ResampleImages | boolean | No | true | Tells the compressor to resample images to a new resolution. See profiles.ResampleImages for more information. |
ResamplingResolution | integer | No | 120 | Target resampled images resolution. See profiles.ResamplingResolution for more information. |
GrayscaleImages | boolean | No | false | Turns all images into grayscale. See profiles.GrayscaleImages for more information. |
DataEncryptionAlgorithm | string | No | - | Controls the encryption algorithm used for data encryption. See User-Controlled Encryption for more information. The available algorithms are: AES128 , AES192 , AES256 . |
DataEncryptionKey | string | No | - | Controls the encryption key used for data encryption. See User-Controlled Encryption for more information. |
DataEncryptionIV | string | No | - | Controls the encryption IV used for data encryption. See User-Controlled Encryption for more information. |
DataDecryptionAlgorithm | string | No | - | Controls the decryption algorithm used for data decryption. See User-Controlled Encryption for more information. The available algorithms are: AES128 , AES192 , AES256 . |
DataDecryptionKey | string | No | - | Controls the decryption key used for data decryption. See User-Controlled Encryption for more information. |
DataDecryptionIV | string | No | - | Controls the decryption IV used for data decryption. See User-Controlled Encryption for more information. |
profiles.ImageOptimizationFormat
(optional) controls image compression format. Available values:
JPEG
(default) JPEG based compression.Flate
(zip-like compression).Fax
1-bit black and white compression, provides best file size.
profiles.JPEGQuality
(optional) controls JPEG compression quality from 1
(worst quality, smallest size) to 100
(best quality, largest size). Set to 25
by default.
profiles.ResampleImages
(optional) tells the compressor to resample images to a new resolution - true
by default.
profiles.ResamplingResolution
(optional) target resampled images resolution. 120
(dots per inch) by default.
profiles.GrayscaleImages
(optional) turns all images into grayscale. Not affecting the compression, but useful if you need to make all images inside grayscale - false
by default.
Query parameters
No query parameters accepted.
Responses
Parameter | Type | Description |
---|---|---|
fileSize | integer | Size of the optimized PDF file in bytes |
urls | array[string] | List of URLs to the final PDF file stored in S3. |
outputLinkValidTill | string | Timestamp indicating when the output link will expire |
pageCount | integer | Number of pages in the PDF document. |
error | boolean | Indicates whether an error occurred (false means success) |
status | string | Status code of the request (200, 404, 500, etc.). For more information, see Response Codes. |
name | string | Name of the output file |
credits | integer | Number of credits consumed by the request |
remainingCredits | integer | Number of credits remaining in the account |
duration | integer | Time taken for the operation in milliseconds |
Example
Payload
To see the request size limits, please refer to the Request Size Limits.
Example
Response
To see the main response codes, please refer to the Response Codes page.