Annota l'API PDF
Aggiungi testo estraibile, evidenziazioni colorate e sovrapposizioni di rettangoli con coordinate precise.
Semantica endpoint e attività#
Codice operazione: annotate
Avvia questa operazione con POST /v1/tasks e il codice dello strumento mostrato sopra. Carica e allega i PDF di origine (o usa gli endpoint di caricamento con ambito task), quindi chiama POST /v1/tasks/{task_id}/process con impostazioni di operazione.
Rivedi un rapporto, aggiungi note di approvazione o contrassegna visivamente le aree senza modificare il testo sottostante.
Input: Un PDF verificato; 1–200 annotazioni su fino a 500 pagine non ruotate.
Configurazione e parametri aggiuntivi#
| Impostazione | Tipo | Comportamento |
|---|---|---|
| annotationsobbligatorio | object[] | Ogni annotazione richiede kind ('text', 'highlight' o 'rectangle'), page (basato su 1), x0/y0/x1/y1 in punti PDF e color (yellow, blue, red, green, black). Text richiede text e font_size (6–48). |
Le opzioni sono convalidate dall'API. Le impostazioni sconosciute e i valori non supportati restituiscono un errore invece di essere ignorati.
Sequenza di richiesta in corso#
Programming language: cURL
Scegli una lingua · scorri orizzontalmente per tutti i 10 linguaggi 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.
I pacchetti scaricabili generati coprono solo il flusso di lavoro dell'attività. Gli SDK full-service richiedono una specifica OpenAPI di runtime verificata; gli SDK delle attività Python, JavaScript e TypeScript trasmettono i caricamenti di file; gli altri linguaggi richiedono caricamenti multipart firmati implementati dal chiamante.
L'ID attività restituito viene utilizzato sia per il polling dello stato che per il recupero. Dopo il completamento dell'attività, richiedi un URL di output firmato anziché incorporare un segreto di download.
Output e dettagli importanti#
Un nuovo PDF con testo/forme di sovrapposizione visibile reale. Non è una redazione sicura.
Questo aggiunge contenuto visivo; non modifica il testo esistente né cancella permanentemente le informazioni sottostanti. Usa Redact PDF per la riservatezza; le firme digitali vengono rifiutate.
Errori, tentativi e fatturazione