API Redact PDF
Rimuovi permanentemente testo, pixel di immagine e contenuto vettoriale sovrapposto dai rettangoli di pagina selezionati esplicitamente.
Semantica endpoint e attività#
Codice operazione: redact
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.
Prepara i documenti revisionati per la divulgazione con aree di contenuto sensibile note.
Input: Esattamente un PDF sigillato; 1–200 rettangoli espliciti, ciascuno all'interno della sua pagina di destinazione.
Configurazione e parametri aggiuntivi#
| Impostazione | Tipo | Comportamento |
|---|---|---|
| regionsobbligatorio | object[] | Ogni regione: {page,x0,y0,x1,y1}, la pagina inizia da 1 e le coordinate del rettangolo utilizzano punti PDF dall'angolo in alto a sinistra della pagina. Tutti i rettangoli devono essere entro i limiti della pagina. |
| strip_metadata | boolean | Rimuovi anche metadati, allegati e script. Predefinito: true. |
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":"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.
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#
Nuovo PDF con contenuto rimosso fisicamente nelle aree contrassegnate e riempimento nero applicato.
Richiede revisione visiva e verifica rispetto all'originale. Non è un rilevatore di redazione semantica; non garantisce che tutte le istanze di un nome altrove in un file siano trovate. Gli oggetti vettoriali intersecanti possono essere rimossi completamente. Le pagine di destinazione devono essere non ruotate e i PDF con campi modulo devono essere appiattiti prima. Le firme digitali esistenti vengono invalidate.
Errori, tentativi e fatturazione