PDFHQ-Logo

Dokumente

DokumentationPDF-Operationen

PDF-Redaktion-API

Entferne Text, Bildpixel und überlappende Vektorinhalte dauerhaft aus explizit ausgewählten Seitenbereichen.

Server-seitige API-Schlüssel Signierte Speicher-Uploads

Endpunkt- und Task-Semantik#

Operationscode: redact

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.

Bereite überprüfte Dokumente zur Offenlegung mit bekannten sensiblen Inhaltsbereichen vor.

Eingaben: Genau ein versiegeltes PDF; 1–200 explizite Rechtecke, jeweils innerhalb seiner Zielseite.

Konfiguration und zusätzliche Parameter#

EinstellungTypVerhalten
regionserforderlich object[]Jede Region: {page,x0,y0,x1,y1}, Seite beginnt bei 1 und Rechteckkoordinaten verwenden PDF-Punkte von der oberen linken Ecke der Seite. Alle Rechtecke müssen innerhalb der Seitengrenzen liegen.
strip_metadatabooleanEntferne auch Metadaten, Anhänge und Skripte. Standard: true.

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

API example · cURL
# 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":"redact"}'

# 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":{"regions":[{"page":1,"x0":72,"y0":100,"x1":300,"y1":132}],"strip_metadata":true}}'

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.

All 10 SDKs ↓Vollständige Python-Anleitung ↓ Vollständige Bash/cURL-Anleitung ↓ Alle Endpoints → Direkte Uploads → Fehlerbehandlung →

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#

Neues PDF mit Inhalten, die in markierten Bereichen physisch entfernt und mit schwarzer Füllung versehen wurden.

Erfordert visuelle Überprüfung und Verifizierung gegen das Original. Kein semantischer Redaktionsdetektor; garantiert nicht, dass alle Instanzen eines Namens an anderer Stelle in einer Datei gefunden werden. Sich schneidende Vektorobjekte können vollständig entfernt werden. Zielseiten müssen ungedreht sein und PDFs mit Formularfeldern müssen zuerst vereinfacht werden. Bestehende digitale Signaturen werden ungültig.

Fehler, Wiederholungen und Abrechnung
PDFHQ-Logo

PDF-Werkzeuge und Dokumentenanalyse. Dokumente vorbereiten, verstehen und bearbeiten.

© 2026 PDFHQ. Alle Rechte vorbehalten.