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" }

AttributeTypeRequiredDefaultDescription
urlstringYes-URL to the source file url attribute
callbackstringNo-The callback URL (or Webhook) used to receive the POST data. see Webhooks & Callbacks. This is only applicable when async is set to true.
httpusernamestringNo-HTTP auth user name if required to access source URL.
httppasswordstringNo-HTTP auth password if required to access source URL.
namestringNo-File name for the generated output, the input must be in string format.
expirationintegerNo60Set 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.
passwordstringNo-Password for the PDF file.
asyncbooleanNofalseSet 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
profilesobjectNo-See Profiles for more information.
ImageOptimizationFormatstringNoJPEGControls image compression format. See profiles.ImageOptimizationFormat for more information.
JPEGQualityintegerNo25Controls JPEG compression quality. See profiles.JPEGQuality for more information.
ResampleImagesbooleanNotrueTells the compressor to resample images to a new resolution. See profiles.ResampleImages for more information.
ResamplingResolutionintegerNo120Target resampled images resolution. See profiles.ResamplingResolution for more information.
GrayscaleImagesbooleanNofalseTurns all images into grayscale. See profiles.GrayscaleImages for more information.
DataEncryptionAlgorithmstringNo-Controls the encryption algorithm used for data encryption. See User-Controlled Encryption for more information. The available algorithms are: AES128, AES192, AES256.
DataEncryptionKeystringNo-Controls the encryption key used for data encryption. See User-Controlled Encryption for more information.
DataEncryptionIVstringNo-Controls the encryption IV used for data encryption. See User-Controlled Encryption for more information.
DataDecryptionAlgorithmstringNo-Controls the decryption algorithm used for data decryption. See User-Controlled Encryption for more information. The available algorithms are: AES128, AES192, AES256.
DataDecryptionKeystringNo-Controls the decryption key used for data decryption. See User-Controlled Encryption for more information.
DataDecryptionIVstringNo-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.

{
 "profiles": "{ 'ImageOptimizationFormat': 'JPEG', 'JPEGQuality': 25, 'ResampleImages': true, 'ResamplingResolution': 120, 'GrayscaleImages': false }"
}

Query parameters

No query parameters accepted.

Responses

ParameterTypeDescription
fileSizeintegerSize of the optimized PDF file in bytes
urlsarray[string]List of URLs to the final PDF file stored in S3.
outputLinkValidTillstringTimestamp indicating when the output link will expire
pageCountintegerNumber of pages in the PDF document.
errorbooleanIndicates whether an error occurred (false means success)
statusstringStatus code of the request (200, 404, 500, etc.). For more information, see Response Codes.
namestringName of the output file
creditsintegerNumber of credits consumed by the request
remainingCreditsintegerNumber of credits remaining in the account
durationintegerTime taken for the operation in milliseconds

Example Payload

To see the request size limits, please refer to the Request Size Limits.

{
  "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-optimize/sample.pdf",
  "name": "output.pdf",
  "profiles": "{ 'ImageOptimizationFormat': 'JPEG', 'JPEGQuality': 25, 'ResampleImages': true, 'ResamplingResolution': 120, 'GrayscaleImages': false }",
  "async": false
}

Example Response

To see the main response codes, please refer to the Response Codes page.

{
  "url": "https://pdf-temp-files.s3.us-west-2.amazonaws.com/TEPHYOOWTKN47RSMF11CXHXHD7U68ZSS/sample-compressed.pdf?X-Amz-Expires=3600&X-Amz-Security-Token=FwoGZXIvYXdzEEsaDMAT9Cnzd6%2FnDfVKYSKCAU6XCvsgWTRfJHWmoO2iJfJ6YSVShb6ddOXU9Ks5G4Ai20O2idqOaLLslwt6uEnT9EbwpzBMEXuqREkoTTmUOEcXJi9zO5lkLoQ16tXCbfmUF8cvJxVYBXGRHJlzHQ20kJtN6lP237e8rlMtNRIK0f1QsIQswfWy2BFz8IuOndZRu8goquiLmQYyKBBjAmoWcEqs0iMA7MizFAdIbFGydTYXcptaixm%2F%2BfayUZKUByJHURU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA4NRRSZPHNTO33MZG/20220915/us-west-2/s3/aws4_request&X-Amz-Date=20220915T135207Z&X-Amz-SignedHeaders=host&X-Amz-Signature=4f3334f68f1a98d3a9bfe09ec03d3e7d10fb7709ce58b711e36652c59a4d6b4a",
  "fileSize": 798621,
  "pageCount": 5,
  "error": false,
  "status": 200,
  "name": "sample-compressed.pdf",
  "credits": 105,
  "duration": 2886,
  "remainingCredits": 98256037
}

Code Samples

curl --location --request POST 'https://api.pdf.co/v1/pdf/optimize' \
--header 'Content-Type: application/json' \
--header 'x-api-key: *******************' \
--data-raw '{
"url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-optimize/sample.pdf",
"name": "output.pdf",
"profiles": "{ '\''ImageOptimizationFormat'\'': '\''JPEG'\'', '\''JPEGQuality'\'': 25, '\''ResampleImages'\'': true, '\''ResamplingResolution'\'': 120, '\''GrayscaleImages'\'': false }",
"async": false
}'