CTRL+K

PDF Compress API

POST

https://api.apifreaks.com/v1.0/pdf/compress

format

Format of the Response

file_idString

If you already uploaded a PDF, enter its ID here instead of uploading again. This saves time when working with the same file multiple times. You can check file status using the File Status API

destroyBoolean

Set to true if you want to permanently delete the original file after processing.

If false, files are retained on our server for up to 30 days based on user's plan. If true, inputs are deleted immediately after task completion and output files are deleted after downloading.

compression_levelStringrequired

Choose compression level from light compression that keeps near-original quality to extreme compression for maximum size reduction. Choose the right balance for your needs.

outputString

Optionally specify a custom name for the compressed PDF output file (without extension).

outputString

Optionally specify a custom name for the output file (without extension).

webhook_urlString

Provide a URL to receive a webhook notification when the task is completed. The notification will include the task status and file ID(s) of the output.

webhook_failure_notificationBoolean

If true, we'll send an email notification if the webhook request fails after 3 retries. The email goes to the requesting user or their org admin if user is part of an organization.

Sample Responses

400

404

415

500

LANGUAGE

Python

PHP

Java

Node

Ruby


$ pip install requests
import requests 

url = "https://api.apifreaks.com/v1.0/pdf/compress"

payload = {}
headers = {
	'X-apiKey': ''
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

RESPONSE

Click Test it to start the request and see the response here!

API Response

Field	Type	Requirement	Description
taskId	String	Mandatory	Unique identifier for the PDF task.
inputIds	Array	Optional	Array of unique file IDs referencing PDF files used in the PDF operation.

$ pip install requests

import requests 

url = "https://api.apifreaks.com/v1.0/pdf/compress"

payload = {}
headers = {
	'X-apiKey': ''
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Field

Type

Requirement

Description

taskId

String

Mandatory

Unique identifier for the PDF task.

inputIds

Array

Optional

Array of unique file IDs referencing PDF files used in the PDF operation.