API Redactar PDF
Elimina permanentemente texto, píxeles de imagen y contenido vectorial superpuesto de rectángulos de página explícitamente seleccionados.
Semántica de punto final y tarea#
Código de operación: redact
Inicia esta operación con POST /v1/tasks y el código de herramienta que se muestra arriba. Cargue y adjunte archivos PDF de origen (o utilice puntos finales de carga con alcance de tarea), luego llame POST /v1/tasks/{task_id}/process con configuración de operación.
Prepara documentos revisados para divulgación con áreas de contenido sensible conocidas.
Entradas: Exactamente un PDF sellado; 1–200 rectángulos explícitos, cada uno dentro de su página de destino.
Configuración y parámetros adicionales#
| Configuración | Tipo | Comportamiento |
|---|---|---|
| regionsobligatorio | object[] | Cada región: {page,x0,y0,x1,y1}, la página comienza en 1 y las coordenadas del rectángulo usan puntos PDF desde la esquina superior izquierda de la página. Todos los rectángulos deben estar dentro de los límites de la página. |
| strip_metadata | boolean | También elimina metadatos, adjuntos y scripts. Predeterminado: true. |
La API valida las opciones. Los parámetros desconocidos y los valores no admitidos devuelven un error en lugar de ignorarse.
Secuencia de solicitud en funcionamiento#
Programming language: cURL
Elige un idioma · desplázate horizontalmente para los 10 idiomas de 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.
Los paquetes descargables generados cubren solo el flujo de tareas. Los SDK de servicio completo requieren una especificación OpenAPI de tiempo de ejecución verificada; los SDK de tareas de Python, JavaScript y TypeScript transmiten cargas de archivos; los otros idiomas requieren cargas multiparte firmadas implementadas por el llamador.
El ID de tarea devuelto se utiliza tanto para sondeo de estado como para recuperación. Después de que la tarea se complete correctamente, solicite una URL de salida firmada en lugar de incrustar un secreto de descarga.
Resultado y detalles importantes#
Nuevo PDF con contenido eliminado físicamente en regiones marcadas y relleno negro aplicado.
Requiere revisión visual y verificación contra el original. No es un detector de redacción semántica; no garantiza que se encuentren todas las instancias de un nombre en otro lugar del archivo. Los objetos vectoriales que se cruzan pueden eliminarse completamente. Las páginas de destino deben estar sin rotar y los PDF con campos de formulario deben aplanarse primero. Las firmas digitales existentes se invalidan.
Errores, reintentos y facturación