GET /api/v1/capabilities
Public. Machine-readable catalog of operations, scopes, and limits. No authentication.
Server-side protect, unlock, and repair for PDFs up to 15 MiB. Same qpdf engine as the website tools. Files are processed in a temp directory and removed after the response.
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.
https://api.quickpdftools.net (set PUBLIC_API_BASE_URL per environment)https://quickpdftools.net/developers/multipart/form-data in, application/pdf outCreate 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.
| Constraint | Value |
|---|---|
| Max upload size | 15 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:
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset (seconds until the current window resets)GET /api/v1/usage returns the same numbers for the key used in the request.
GET /api/v1/capabilitiesPublic. Machine-readable catalog of operations, scopes, and limits. No authentication.
GET /api/v1/usageRequires API key. Returns rate-limit snapshot for that key.
POST /api/v1/pdf/protectFields: file (PDF), password (1–128 chars). Encrypts with AES-256 via qpdf.
POST /api/v1/pdf/unlockFields: file, password. Removes encryption when the password is correct. We do not brute-force passwords.
POST /api/v1/pdf/repairField: file only. Rebuilds broken cross-references where qpdf can recover structure.
JSON errors use shape { "error": "…", "code": "…" } unless noted.
| HTTP | code | When |
|---|---|---|
| 401 | unauthorized | Missing or invalid API key |
| 403 | forbidden_scope | Key lacks scope for the operation |
| 413 | file_too_large | Body over 15 MiB |
| 429 | rate_limited | Hourly or daily cap; check Retry-After |
| 408 | processing_failed | qpdf timeout |
| 400 | processing_failed | Bad PDF, wrong password, invalid multipart |
| 503 | accounts_disabled | Server has no account database configured |
Set BASE to your host and QPDF_API_KEY from the keys panel below.
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 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 curl -sS -X POST "$BASE/api/v1/pdf/repair" \ -H "Authorization: Bearer $QPDF_API_KEY" \ -F "[email protected]" \ -o repaired.pdf curl -sS "$BASE/api/v1/capabilities" | jq.operations[].id Sign in to create and revoke keys. Up to 8 active keys per account.
API keys require Postgres (DATABASE_URL) on this server.
Copy this key now — it will not be shown again.
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.
code valuesLive GET /api/v1/capabilities also includes openData pointing at the manifest. CORS allows * for /developers/oss/* so tools can fetch metadata from other origins.
Watch GET /api/v1/capabilities for new operations entries when we ship them.