PDFHQ-logo

Documenten

DocumentatiePDF-bewerkingen

PDF annoteren API

Voeg extracteerbare tekst, gekleurde markeringen en rechthoekige overlays met nauwkeurige coördinaten toe.

Server-side API-sleutels Ondertekende opslagupload

Eindpunt- en taaksemantiek#

Bewerkingscode: annotate

Start deze bewerking met POST /v1/tasks en de hierboven weergegeven toolcode. Upload en voeg bron-PDF's toe (of gebruik taakgerelateerde upload-eindpunten), vervolgens roep aan POST /v1/tasks/{task_id}/process met bewerkingsinstellingen.

Bekijk een rapport, voeg goedkeuringsopmerkingen toe of markeer visueel regio's zonder de onderliggende tekst te bewerken.

Invoer: Één geverifieerde PDF; 1–200 annotaties op maximaal 500 niet-geroteerde pagina's.

Configuratie en extra parameters#

InstellingTypGedrag
annotationsverplicht object[]Elke annotatie vereist kind ('text', 'highlight' of 'rectangle'), page (op 1 gebaseerd), x0/y0/x1/y1 in PDF-punten en color (yellow, blue, red, green, black). Text vereist text en font_size (6–48).

Opties worden gevalideerd door de API. Onbekende instellingen en niet-ondersteunde waarden retourneren een fout in plaats van te worden genegeerd.

Werkende aanvraagvolgorde#

Programming language: cURL

Kies een taal · scroll horizontaal voor alle 10 SDK-talen

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 ↓Volledige Python-walkthrough ↓ Volledige Bash/cURL-walkthrough ↓ Alle eindpunten → Directe uploads → Foutafhandeling →

Gegenereerde downloadbare pakketten dekken alleen de taakwerkstroom. Full-service SDK's vereisen een geverifieerde runtime OpenAPI-specificatie; de Python-, JavaScript- en TypeScript-taak-SDK's streamen bestandsuploads; de andere talen vereisen ondertekende multipart-uploads geïmplementeerd door de aanroeper.

De geretourneerde taak-ID wordt gebruikt voor zowel statuspolling als ophalen. Nadat de taak is voltooid, vraagt u een ondertekende uitvoer-URL aan in plaats van een downloadgeheim in te sluiten.

Uitvoer en belangrijke details#

Een nieuwe PDF met echte zichtbare overlay-tekst/vormen. Dit is geen veilige redactie.

Dit voegt visuele inhoud toe; het wijzigt geen bestaande tekst of wist onderliggende informatie permanent. Gebruik Redact PDF voor vertrouwelijkheid; digitale handtekeningen worden afgewezen.

Fouten, nieuwe pogingen en facturering
PDFHQ-logo

PDF-tools en documentintelligentie. Bereid, begrijp en werk met uw documenten.

© 2026 PDFHQ. Alle rechten voorbehouden.