API para aplanar formularios PDF y anotaciones
Integra campos de formulario y anotaciones compatibles en la apariencia permanente de la página.
Semántica de punto final y tarea#
Código de operación: flatten
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.
Comparte formularios completados revisados sin dejar campos interactivos ni comentarios editables.
Entradas: Un PDF, máximo 100 MiB y 500 páginas; pueden aplicarse límites de cuenta más bajos.
Configuración y parámetros adicionales#
Esta operación no requiere opciones adicionales. Envíe un objeto de opciones vacío.
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":"flatten"}'
# 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":{}}'
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 anotaciones compatibles y campos de formulario incrustados como contenido no interactivo.
El aplanamiento no es redacción ni sanitización forense. Los PDF firmados y formularios XFA se rechazan; verifica la fidelidad en apariencias de formularios complejos.
Errores, reintentos y facturación