API Annoter PDF
Ajouter du texte extractible, des surlignages colorés et des superpositions de rectangles avec des coordonnées précises.
Sémantique du point de terminaison et de la tâche#
Code d'opération : annotate
Commencez cette opération avec POST /v1/tasks et le code d'outil affiché ci-dessus. Importez et joignez les PDF source (ou utilisez les points de terminaison d'importation limités à la tâche), puis appelez POST /v1/tasks/{task_id}/process avec les paramètres d'opération.
Examinez un rapport, ajoutez des notes d'approbation ou marquez visuellement des régions sans modifier le texte sous-jacent.
Entrées : Un PDF vérifié ; 1–200 annotations sur jusqu'à 500 pages non pivotées.
Configuration et paramètres supplémentaires#
| Paramètre | Tapez | Comportement |
|---|---|---|
| annotationsobligatoire | object[] | Chaque annotation nécessite kind ('text', 'highlight' ou 'rectangle'), page (basée sur 1), x0/y0/x1/y1 en points PDF, et color (yellow, blue, red, green, black). Text nécessite text et font_size (6–48). |
Les options sont validées par l'API. Les paramètres inconnus et les valeurs non prises en charge retournent une erreur au lieu d'être ignorés.
Séquence de demande en cours#
Programming language: cURL
Choisir une langue · faites défiler horizontalement pour les 10 langages SDK
# 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.
Les packages téléchargeables générés couvrent uniquement le flux de travail des tâches. Les SDK de service complet nécessitent une spécification OpenAPI de runtime vérifiée ; les SDK de tâches Python, JavaScript et TypeScript diffusent les importations de fichiers ; les autres langues nécessitent des importations multipart signées implémentées par l'appelant.
L'ID de tâche retourné est utilisé à la fois pour l'interrogation du statut et la récupération. Une fois la tâche réussie, demandez une URL de sortie signée plutôt que d'intégrer un secret de téléchargement.
Résultat et détails importants#
Un nouveau PDF avec du texte/des formes de superposition visibles réels. Ce n'est pas une rédaction sécurisée.
Cela ajoute du contenu visuel ; cela ne modifie pas le texte existant ni n'efface définitivement les informations sous-jacentes. Utilisez Redact PDF pour la confidentialité ; les signatures numériques sont rejetées.
Erreurs, tentatives et facturation