PDF-Komprimierungs-API
Komprimiere PDFs asynchron mit kontrollierten Einstellungen für Größe versus Qualität. Bewahre die ursprüngliche Eingabe im privaten Speicher auf und rufe das verarbeitete Artefakt mit einer ablaufenden URL ab.
Endpunkt- und Task-Semantik#
Operationscode: compress
Starten Sie diesen Vorgang mit POST /v1/tasks und den oben angezeigten Tool-Code. Lade Quell-PDFs hoch und füge sie an (oder verwende Task-bezogene Upload-Endpunkte), dann rufe auf POST /v1/tasks/{task_id}/process mit Operationseinstellungen.
Komprimiere gescannte Berichte und E-Mail-Anhänge vor der Verteilung.
Eingaben: 1–12 verifizierte PDF-Uploads, in dieser Reihenfolge eingereicht.
Konfiguration und zusätzliche Parameter#
| Einstellung | Typ | Verhalten |
|---|---|---|
| compression_level | string enum | empfohlen, extrem oder niedrig; unbekannte Werte schlagen die Validierung fehl. Standard: recommended. |
Optionen werden von der API validiert. Unbekannte Einstellungen und nicht unterstützte Werte geben einen Fehler zurück, statt ignoriert zu werden.
Arbeitende Anforderungssequenz#
Programming language: cURL
Wähle eine Sprache · scrolle horizontal für alle 10 SDK-Sprachen
# Server-side API calls. Save the returned task_id.
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks' \
-H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
-d '{"tool":"compress"}'
# Upload and verify 1 PDF(s), then obtain and approve a credit quote:
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID/quote' -H 'x-api-key: YOUR_API_KEY'
# ONLY after explicit customer approval:
test "$PDFHQ_APPROVE_QUOTE" = yes || { echo "Approval required" >&2; exit 1; }
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks/TASK_ID/process' \
-H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
-d '{"options":{"compression_level":"recommended"}}'
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID' -H 'x-api-key: YOUR_API_KEY'After starting a task, upload and verify PDFs, review the credit quote, and get explicit approval before processing. API keys belong on your server, never on signed storage uploads.
Generierte herunterladbare Pakete decken nur den Task-Workflow ab. Vollständige SDKs erfordern eine verifizierte OpenAPI-Spezifikation; die Python-, JavaScript- und TypeScript-Task-SDKs streamen Datei-Uploads; die anderen Sprachen erfordern signierte Multipart-Uploads, die vom Aufrufer implementiert werden.
Die zurückgegebene Aufgaben-ID wird sowohl für die Statusabfrage als auch für den Abruf verwendet. Nachdem die Aufgabe erfolgreich war, fordern Sie eine signierte Ausgabe-URL an, anstatt ein Download-Geheimnis einzubetten.
Ausgabe und wichtige Details#
Gebe PDF oder ZIP aus, wie von der zugrunde liegenden Verarbeitungs-Pipeline ausgewählt.
Komprimierung garantiert nicht unbedingt eine kleinere Ausgabegröße für jede PDF. Überprüfe die tatsächliche Ausgabegröße.
Fehler, Wiederholungen und Abrechnung