# PDF Compressor API (`api-center/pdf-compress-api`) Actor

Compress a PDF from a URL or file upload and save the result to the run's key-value store.

- **URL**: https://apify.com/api-center/pdf-compress-api.md
- **Developed by:** [Leo Yan](https://apify.com/api-center) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.002 / actor start

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## PDF Compressor

Compress a PDF from a public URL or a file upload. Files up to **256 MB** are supported. The
compressed PDF is written to the run's default key-value store, together with a machine-readable
`OUTPUT` record.

The Actor uses an enterprise-grade PDF compression engine to remove redundant objects and
recompress images while keeping the document readable. It is intended to be called through the
Apify API or from Apify Console.

### Input

| Field | Type | Default | Description |
| --- | --- | --- | --- |
| `url` | string | [sample GeoTopo PDF](https://raw.githubusercontent.com/py-pdf/sample-files/main/009-pdflatex-geotopo/GeoTopo.pdf) | Public HTTP(S) URL of the PDF. |
| `fileUpload` | string | - | Uploaded PDF or Apify key-value store record URL. Takes precedence over `url`. |
| `compressionLevel` | string | `recommended` | `low`, `recommended`, or `extreme`. |

#### Compression levels

| Level | Image resolution | JPEG quality | Best for |
| --- | --- | --- | --- |
| `low` | 300 DPI | 90 | Print quality, scans, documents with fine detail |
| `recommended` | 150 DPI | 75 | General web and email use |
| `extreme` | 96 DPI | 50 | The smallest possible file, image-heavy PDFs |

If the compressor cannot make the PDF smaller, the original PDF is returned unchanged under the
`_compress.pdf` name. Password-protected PDFs are rejected because their content cannot be
optimized.

### Output

For an input named `input.pdf`, the compressed file is stored in the run's default key-value
store under `input_compress.pdf` with content type `application/pdf`.

When the run finishes, the **Output** tab in Apify Console lists the compressed PDF and links to
the `OUTPUT` record. These links are defined in `.actor/output_schema.json`.

An `OUTPUT` JSON record describes the result:

```json
{
  "success": true,
  "message": "Compressed 5.1 MB to 1.7 MB (66.5% smaller).",
  "input": {
    "source": "https://example.com/GeoTopo.pdf",
    "filename": "GeoTopo.pdf",
    "bytes": 5321132,
    "mb": "5.1 MB"
  },
  "output": {
    "key": "GeoTopo_compress.pdf",
    "filename": "GeoTopo_compress.pdf",
    "contentType": "application/pdf",
    "bytes": 1783266,
    "mb": "1.7 MB",
    "compressionRatio": 0.335,
    "savedPercent": 66.5,
    "downloadUrl": "https://api.apify.com/v2/key-value-stores/STORE_ID/records/GeoTopo_compress.pdf?signature=..."
  },
  "compressionLevel": "recommended",
  "pricing": {
    "eventName": "pdf-mb",
    "unitPriceUsd": 0.001,
    "chargedEvents": 6,
    "estimatedCostUsd": 0.006,
    "charged": true,
    "actorStart": {
      "eventName": "apify-actor-start",
      "unitPriceUsd": 0.002,
      "events": 1,
      "estimatedCostUsd": 0.002,
      "chargedAutomatically": true
    },
    "estimatedTotalCostUsd": 0.008
  },
  "limits": {
    "memoryMb": 512,
    "maxMemoryMb": 512,
    "diskMb": 1024,
    "maxInputBytes": 268435456,
    "maxInputMb": 256
  }
}
```

On failure, `success` is `false`, `error.code` identifies the problem, and `error.message`
contains a user-facing explanation. The `OUTPUT` record is written for both successful and
failed runs.

#### Filename rules

- `input.pdf` -> `input_compress.pdf`
- `report.PDF` -> `report_compress.PDF`
- `report` -> `report_compress.pdf`

Only PDF input is accepted. The URL does not need to end in `.pdf`; the downloaded content is
checked for a PDF header, and non-PDF content is rejected with `NOT_A_PDF` before compression
starts.

Filenames are sanitized before use with a cross-platform filename cleaner. Directory components are
removed, characters that are invalid in filenames are stripped, reserved device names are defused,
and trailing dots or spaces are removed. The remaining name is then normalized to letters, digits,
`.`, `_`, and `-`, and truncated to a safe length. For example, `hello world.pdf` becomes
`hello_world_compress.pdf`.

### Pricing

The Actor uses **pay-per-event (PPE)** pricing with two charges.

#### Per-run fee

Apify charges the synthetic `apify-actor-start` event automatically at **$0.002 per start**
(**$2 per 1,000 runs**). It applies to every run, including runs that later fail, and is not
charged by the Actor code.

The event is charged once for every run. Because the Actor's memory is fixed at 512 MB, each run
incurs exactly one start event ($0.002).

#### Per-MB fee

The Actor charges the event `pdf-mb` **once per started megabyte of the input file**, at
**$0.001 per event**:

- 1 byte to 1 MB -> 1 event -> $0.001
- 5.1 MB -> 6 events -> $0.006
- 128 MB -> 128 events -> $0.128
- 256 MB -> 256 events -> $0.256

This event is charged only after the compressed PDF has been saved to the key-value store. Failed
runs, including oversized inputs, are not charged for `pdf-mb`.

#### Total cost

| Input | Start fee | `pdf-mb` | Total |
| --- | --- | --- | --- |
| 1 byte to 1 MB | $0.002 | $0.001 | $0.003 |
| 5.1 MB | $0.002 | $0.006 | $0.008 |
| 128 MB | $0.002 | $0.128 | $0.130 |
| 256 MB | $0.002 | $0.256 | $0.258 |

The `pricing` object in `OUTPUT` reports both the `pdf-mb` charge and the automatic start fee.

### Size limits

The Actor runs with **512 MB of memory** and **1 GB of disk** (Apify gives each run disk space
equal to twice its memory). To leave headroom for the compression engine and the output file, the
input limit is half the memory:

```text
max input size = memory / 2 = 256 MB
```

| Memory | Disk | Maximum input |
| --- | --- | --- |
| 512 MB (fixed) | 1 GB | 256 MB |

The Actor checks the remote `Content-Length` before downloading. If the server does not report a
size, the same limit is enforced while streaming the download. An oversized file produces an
`OUTPUT` record with `error.code = "FILE_TOO_LARGE"` and no `pdf-mb` charge.

Files larger than 256 MB cannot be processed by this Actor; split them into smaller PDFs before
uploading. The default run timeout is **10 minutes**.

### Calling the API

Start an asynchronous run:

```bash
curl -X POST "https://api.apify.com/v2/acts/OWNER~pdf-compress-api/runs?token=$APIFY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://raw.githubusercontent.com/py-pdf/sample-files/main/009-pdflatex-geotopo/GeoTopo.pdf",
    "compressionLevel": "recommended"
  }'
```

The response contains `data.id`, `data.defaultKeyValueStoreId`, and `data.status`. Poll the run,
then read the metadata and download the result:

```bash
curl "https://api.apify.com/v2/actor-runs/RUN_ID?token=$APIFY_TOKEN"

curl "https://api.apify.com/v2/key-value-stores/STORE_ID/records/OUTPUT?token=$APIFY_TOKEN"

curl -OJ "https://api.apify.com/v2/key-value-stores/STORE_ID/records/GeoTopo_compress.pdf?token=$APIFY_TOKEN"
```

Synchronous call (waits for the run to finish):

```bash
curl -X POST "https://api.apify.com/v2/acts/OWNER~pdf-compress-api/run-sync?token=$APIFY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/input.pdf"}'
```

Uploading a file is also supported. Upload the PDF to a key-value store, then pass the record URL
as `fileUpload`:

```bash
curl -X POST "https://api.apify.com/v2/acts/OWNER~pdf-compress-api/runs?token=$APIFY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fileUpload": "https://api.apify.com/v2/key-value-stores/STORE_ID/records/input.pdf",
    "compressionLevel": "extreme"
  }'
```

### Error codes

| Code | Meaning |
| --- | --- |
| `INVALID_INPUT` | Missing/invalid URL, unsupported scheme, or invalid compression level. |
| `DOWNLOAD_FAILED` | The source could not be downloaded (DNS, TLS, HTTP 4xx/5xx, timeout). |
| `EMPTY_FILE` | The source returned an empty file. |
| `NOT_A_PDF` | The file is not a valid PDF or has no readable pages. |
| `PASSWORD_PROTECTED` | The PDF is encrypted and needs a password. |
| `COMPRESSION_FAILED` | The compressor could not optimize the document. |
| `UPLOAD_FAILED` | The result could not be written to the key-value store. |
| `FILE_TOO_LARGE` | The input exceeds the run's memory-derived limit. |
| `TEMP_DIR_FAILED` | The run could not create a temporary directory. |

***

# Actor input Schema

## `url` (type: `string`):

Public HTTP(S) URL of the PDF to compress. The default is a sample PDF that is useful for testing.

## `fileUpload` (type: `string`):

Upload a PDF or paste an Apify key-value store record URL. When provided, this file takes precedence over the PDF URL field.

## `compressionLevel` (type: `string`):

Choose the trade-off between visual quality and file size. Low keeps the best quality, while Extreme produces the smallest file.

## Actor input object example

```json
{
  "url": "https://raw.githubusercontent.com/py-pdf/sample-files/main/009-pdflatex-geotopo/GeoTopo.pdf",
  "compressionLevel": "recommended"
}
```

# Actor output Schema

## `compressedPdf` (type: `string`):

Contents of the run's default key-value store. The compressed file is stored as <original-name>\_compress.pdf with content type application/pdf. If the input PDF is already well optimized, the original file is returned unchanged under the same name.

## `result` (type: `string`):

JSON record describing the run: success flag, message, input and output sizes, compression ratio and saved percentage, output record key, download URL, pricing, and limits. Failed runs set success to false and include error.code and error.message.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("api-center/pdf-compress-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("api-center/pdf-compress-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call api-center/pdf-compress-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,api-center/pdf-compress-api"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/5kft2ajA9RN64YKul/builds/Jo1KBgdHCgDhoeWqo/openapi.json