Quick PDF Tools API

Overview

Version 1 is a synchronous HTTP API on a dedicated API host (horizontally scaled apart from the public website). Send a PDF as multipart/form-data, receive PDF bytes on success. Browser tool routes under /api/pdf/* stay on the website origin (same-origin only). API keys and docs are managed on the site; PDF jobs run on the API service.

API base URL
https://api.quickpdftools.net (set PUBLIC_API_BASE_URL per environment)
Docs & keys
https://quickpdftools.net/developers/
Format
multipart/form-data in, application/pdf out
Included tier
No billing in v1; fair-use rate limits apply per API key

Authentication

Create a key after signing in. Keys start with qpdf_live_. Send them on every mutating request:

Authorization: Bearer qpdf_live_xxxxxxxx

Keys are stored as hashes on our side. The full secret is shown once at creation. Revoke compromised keys immediately and issue a new one.

Do not embed keys in client-side web apps or mobile apps — call the API from your server only.

Limits & response headers

ConstraintValue
Max upload size15 MiB per file
Requests per hour (per key)60
Requests per day (per key)500
Concurrent jobs (per server instance)2
Processing timeout~25 seconds

Successful responses include:

GET /api/v1/usage returns the same numbers for the key used in the request.

Endpoints

GET /api/v1/capabilities

Public. Machine-readable catalog of operations, scopes, and limits. No authentication.

GET /api/v1/usage

Requires API key. Returns rate-limit snapshot for that key.

POST /api/v1/pdf/protect

Fields: file (PDF), password (1–128 chars). Encrypts with AES-256 via qpdf.

POST /api/v1/pdf/unlock

Fields: file, password. Removes encryption when the password is correct. We do not brute-force passwords.

POST /api/v1/pdf/repair

Field: file only. Rebuilds broken cross-references where qpdf can recover structure.

Errors

JSON errors use shape { "error": "…", "code": "…" } unless noted.

HTTPcodeWhen
401unauthorizedMissing or invalid API key
403forbidden_scopeKey lacks scope for the operation
413file_too_largeBody over 15 MiB
429rate_limitedHourly or daily cap; check Retry-After
408processing_failedqpdf timeout
400processing_failedBad PDF, wrong password, invalid multipart
503accounts_disabledServer has no account database configured

Examples

Set BASE to your host and QPDF_API_KEY from the keys panel below.

Protect

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

Unlock

curl -sS -X POST "$BASE/api/v1/pdf/unlock" \ -H "Authorization: Bearer $QPDF_API_KEY" \ -F "[email protected]" \ -F "password=known-password" \ -o unlocked.pdf

Repair

curl -sS -X POST "$BASE/api/v1/pdf/repair" \ -H "Authorization: Bearer $QPDF_API_KEY" \ -F "[email protected]" \ -o repaired.pdf

Check capabilities (no key)

curl -sS "$BASE/api/v1/capabilities" | jq.operations[].id

API keys

Sign in to create and revoke keys. Up to 8 active keys per account.

Open data (CC0)

Machine-readable specs, error catalogs, sample PDFs, and a Postman collection you can mirror or ship in your own repos — no API key to download. Licensed under CC0 1.0.

Live GET /api/v1/capabilities also includes openData pointing at the manifest. CORS allows * for /developers/oss/* so tools can fetch metadata from other origins.

Roadmap

Watch GET /api/v1/capabilities for new operations entries when we ship them.