Developers · 7 min read · Quick PDF Tools team

Quick PDF Tools API v1: protect, unlock, and repair PDFs from your server

Automate PDF password protection, unlock, and repair with API keys, OpenAPI 3.1, CC0 fixtures, and fair-use limits — the same qpdf engine as the website tools.

When the browser tool is not enough

The Protect, Unlock, and Repair pages on Quick PDF Tools are built for people clicking through a form. They support large files (up to 500 MiB on the website) with a clear consent step before upload.

If you run a backend — invoicing, compliance, document ingestion, or a support bot — you need the same qpdf operations on a schedule, without a browser. That is what API v1 is for.

What the API does today

Version 1 is a synchronous REST API on a dedicated host (api.quickpdftools.net). You send multipart/form-data with a PDF; on success you get application/pdf bytes back.

  • POST /api/v1/pdf/protect — AES-256 encryption with your password
  • POST /api/v1/pdf/unlock — remove encryption when the password is correct (no brute force)
  • POST /api/v1/pdf/repair — rebuild broken cross-references where qpdf can recover
  • GET /api/v1/capabilities — public catalog of operations and limits
  • GET /api/v1/usage — rate-limit snapshot for your key

Files are processed in a temp directory and removed after the response. Merge, split, and in-browser-only tools are not in v1.

Get an API key

Sign in at Account, then open Developers → API keys. Keys start with qpdf_live_ and are shown once at creation. Send them as:

Authorization: Bearer qpdf_live_…

Do not embed keys in mobile apps or public JavaScript — call the API from your server only.

Limits you should plan for

LimitValue
Max upload15 MiB per file
Requests per hour (per key)60
Requests per day (per key)500
Processing timeout~25 seconds

The website tools allow larger uploads for manual jobs. For bigger files in automation, compress or split in the browser first, or batch smaller inputs.

OpenAPI and CC0 open data

Download OpenAPI 3.1 from the site, or mirror the public GitHub repo quickpdf-api-data (CC0). It includes error codes, rate-limit docs, a Postman collection, and sample PDFs (locked, damaged, multi-page).

Live capabilities (no key): GET https://api.quickpdftools.net/api/v1/capabilities

Example: protect a PDF with curl

export BASE="https://api.quickpdftools.net"
export QPDF_API_KEY="qpdf_live_your_key"
curl -sS -X POST "$BASE/api/v1/pdf/protect" \ -H "Authorization: Bearer $QPDF_API_KEY" \ -F "[email protected]" \ -F "password=Str0ngPass" \ -o invoice-protected.pdf

Errors return JSON with a stable code field — see the error catalog on the developer page.

Same engine as the website

API jobs use the same qpdf-backed paths as the matching website tools. If a file works on Repair PDF in the browser, it is a good candidate for /api/v1/pdf/repair under the API size cap.

For human-sized workflows, keep using the tools. For webhooks and workers, use the API.

Open developer docs

FAQ

Is the API?

v1 is included with a account — fair-use rate limits apply per key. There is no billing integration in v1.

Can I call the API from the browser?

No. Keys must stay on your server. The website also exposes a read-only capabilities URL for discovery; mutating routes require a Bearer token from a backend.

Where is the API documented?

Start at /developers/ for keys, examples, and links to OpenAPI and CC0 fixtures.

← All posts · PDF tools home