PDFHQ-Logo

Dokumente

DokumentationPDF-Operationen

PDF-API mit Anmerkungen versehen

Füge extrahierbaren Text, farbige Hervorhebungen und Rechteck-Overlays mit genauen Koordinaten hinzu.

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

Endpunkt- und Task-Semantik#

Operationscode: annotate

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.

Überprüfe einen Bericht, füge Genehmigungsnotizen hinzu oder markiere visuell Bereiche, ohne den zugrunde liegenden Text zu bearbeiten.

Eingaben: Ein verifiziertes PDF; 1–200 Anmerkungen auf bis zu 500 nicht gedrehten Seiten.

Konfiguration und zusätzliche Parameter#

EinstellungTypVerhalten
annotationserforderlich object[]Jede Anmerkung erfordert kind ('text', 'highlight' oder 'rectangle'), page (1-basiert), x0/y0/x1/y1 in PDF-Punkten und color (yellow, blue, red, green, black). Text erfordert text und font_size (6–48).

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":"annotate"}'

# 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":{"annotations":[{"kind":"text","page":1,"x0":50,"y0":100,"x1":420,"y1":175,"color":"blue","text":"Reviewed","font_size":16}]}}'

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#

Eine neue PDF mit echtem sichtbarem Overlay-Text/Formen. Dies ist keine sichere Schwärzung.

Dies fügt visuellen Inhalt hinzu; es ändert keinen vorhandenen Text und löscht keine zugrunde liegenden Informationen dauerhaft. Verwende Redact PDF für Vertraulichkeit; digitale Signaturen werden abgelehnt.

Fehler, Wiederholungen und Abrechnung
PDFHQ-Logo

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

© 2026 PDFHQ. Alle Rechte vorbehalten.