API Anotar PDF
Añade texto extraíble, resaltados de color y superposiciones de rectángulos con coordenadas precisas.
Semántica de punto final y tarea#
Código de operación: annotate
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.
Revisa un informe, añade notas de aprobación o marca visualmente regiones sin editar el texto subyacente.
Entradas: Un PDF verificado; 1–200 anotaciones en hasta 500 páginas sin rotar.
Configuración y parámetros adicionales#
| Configuración | Tipo | Comportamiento |
|---|---|---|
| annotationsobligatorio | object[] | Cada anotación requiere kind ('text', 'highlight' o 'rectangle'), page (basado en 1), x0/y0/x1/y1 en puntos PDF y color (yellow, blue, red, green, black). Text requiere text y font_size (6–48). |
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":"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.
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#
Un nuevo PDF con texto/formas de superposición visible real. No es una redacción segura.
Esto añade contenido visual; no modifica el texto existente ni borra permanentemente la información subyacente. Usa Redact PDF para confidencialidad; las firmas digitales se rechazan.
Errores, reintentos y facturación