80 / 80 Las operaciones de desarrollador descubiertas tienen esquemas registrados. Los ejemplos se generan a partir de esos esquemas y son ejemplos de documentación. El API Lab opcional a continuación permite solo solicitudes GET de solo lectura seleccionadas con una clave de proyecto en memoria; nunca realiza operaciones facturables.
Un contrato registrado no es prueba de una función implementada. Las operaciones de IA y firma pueden estar limitadas o solo en sandbox. Consulte las guías del proveedor y de lanzamiento.
Todas las categorías de API AI DOCUMENT-JOBS DOCUMENTS ESIGN TASK-TOOLS TASKS WEBHOOKS WORKSPACE
Programming language
Example notes languageEN FR DE ES PT ID NL IT TR PL Elige un idioma · desplázate horizontalmente para los 10 idiomas de SDK
cURL Python JavaScript TypeScript Go Java C# / .NET C++ Rust PHP Ruby
Operación API (80 coincidencia)
GET /v1/ai/billing/balance — Ver tu cartera compartida de créditos HQ GET /v1/ai/billing/models — Descubra modelos de IA de PDFHQ seleccionados y disponibilidad con precios GET /v1/ai/billing/prices — Listar precios activos de PDFHQ AI POST /v1/ai/billing/quotes — Cotice el uso de IA de PDFHQ en ambas monedas GET /v1/ai/billing/quotes/{quote_id} — Inspeccionar una cotización de IA propiedad de la cuenta existente POST /v1/ai/edit-plans/from-job — Revalidar una sugerencia de edición de página de IA pagada contra su PDF sellado original e emitir un token de revisión de usuario POST /v1/ai/edit-plans/preview — Obtener vista previa de cambios de PDF en inglés plano determinista sin cobrar créditos GET /v1/ai/jobs — Lista tus trabajos de documentos de IA POST /v1/ai/jobs — Iniciar una operación documental de IA con cotización en créditos HQ POST /v1/ai/jobs/invoices/batch.xlsx — Exporta hasta diez trabajos de factura ya completados en un libro de trabajo de revisión GET /v1/ai/jobs/usage — Uso de trabajos de IA con alcance de cuenta y recuentos de tokens (sin contenido de documento) DELETE /v1/ai/jobs/{job_id} — Elimina un resultado de documento de IA completado GET /v1/ai/jobs/{job_id} — Sondea el estado y el resultado de IA citado GET /v1/ai/jobs/{job_id}/comparison.csv — Exporta cambios de contrato citados para revisión humana como CSV seguro GET /v1/ai/jobs/{job_id}/comparison.xlsx — Descarga un libro de trabajo de revisión de cambios de contrato vinculado a la fuente GET /v1/ai/jobs/{job_id}/conversation — Lee los turnos citados de una conversación propia y no vencida GET /v1/ai/jobs/{job_id}/evidence.csv — Exporta los fragmentos de fuente citados de un resultado de IA de tu propiedad para revisión privada humana GET /v1/ai/jobs/{job_id}/export.{fmt} — Descarga un resultado de revisión de IA privado y validado por citas (JSON, PDF, DOCX o XLSX) GET /v1/ai/jobs/{job_id}/invoice-lines.csv — Exporta elementos de línea de factura citados para revisión humana GET /v1/ai/jobs/{job_id}/invoice.csv — Exportar campos de factura para revisión como CSV seguro GET /v1/ai/jobs/{job_id}/invoice.xlsx — Descargar un libro de trabajo de revisión de factura vinculado a evidencia y con alcance de cuenta GET /v1/document-jobs — Listar trabajos de documentos recientes con alcance de cuenta y clave de API POST /v1/document-jobs — Procesa PDFs cargados de forma asincrónica GET /v1/document-jobs/{job_id}/download-url — Obtener una URL de descarga directa temporal POST /v1/documents/uploads — Crear una carga directa de PDF DELETE /v1/documents/uploads/{upload_id} — Elimina un documento cargado sin usar GET /v1/documents/uploads/{upload_id} — Inspecciona un documento cargado POST /v1/documents/uploads/{upload_id}/complete — Verificar y sellar PDF cargado GET /v1/documents/uploads/{upload_id}/evidence — Extraer texto citado por página de un PDF verificado (vista previa limitada) GET /v1/documents/uploads/{upload_id}/form-fields — Descubra nombres de campos AcroForm compatibles, tipos y números de página GET /v1/esign/envelopes — Lista tus propias solicitudes de firma POST /v1/esign/envelopes — Crear un borrador de solicitud de firma electrónica DELETE /v1/esign/envelopes/{envelope_id} — Descartar un borrador no enviado sin contactar al proveedor GET /v1/esign/envelopes/{envelope_id} — Obtener estado de solicitud de firma PATCH /v1/esign/envelopes/{envelope_id} — Editar un borrador de firma no enviado usando una versión de borrador exacta POST /v1/esign/envelopes/{envelope_id}/archive — Guarde un PDF firmado completado por el proveedor en almacenamiento privado GET /v1/esign/envelopes/{envelope_id}/audit — Leer integridad de firma electrónica con alcance de cuenta y recepción de eventos GET /v1/esign/envelopes/{envelope_id}/download-url — Emitir URL de descarga de documento firmado privado de corta duración POST /v1/esign/envelopes/{envelope_id}/remind — Envía un recordatorio de firmante de sandbox por cada 24 horas, sin reintentos GET /v1/esign/envelopes/{envelope_id}/reminders — Listar recibos de intentos de recordatorio privado sin direcciones de correo electrónico del firmante POST /v1/esign/envelopes/{envelope_id}/send — Envía una solicitud de firma de sandbox explícitamente aprobada POST /v1/esign/envelopes/{envelope_id}/sync — Actualizar una solicitud de sandbox del proveedor de firma sin reenviar GET /v1/esign/envelopes/{envelope_id}/timeline — Lee la línea de tiempo de actividad de solicitud de firma segura para la privacidad POST /v1/esign/envelopes/{envelope_id}/validate — Validar diseño de campo de borrador contra PDF de origen sellado POST /v1/esign/envelopes/{envelope_id}/void — Pone en cola la cancelación de una solicitud de firma en sandbox; verifica el estado final por separado GET /v1/esign/providers — Enumera proveedores de firma electrónica y su disponibilidad real GET /v1/esign/reports/export.csv — Exportar metadatos operacionales de solicitud de firma privada como CSV GET /v1/esign/reports/summary — Resumen de actividad de solicitud de firma de sandbox privado GET /v1/task-tools — Listar las operaciones y configuraciones de tareas PDF disponibles GET /v1/task-tools/{tool} — Describir una operación de tarea y sus opciones aceptadas GET /v1/tasks — Lista tus tareas de documentos POST /v1/tasks — Iniciar una tarea de documento DELETE /v1/tasks/{task_id} — Descarta una tarea en espera GET /v1/tasks/{task_id} — Recuperar estado de la tarea GET /v1/tasks/{task_id}/download-url — Obtén la URL de descarga de salida privada de una tarea POST /v1/tasks/{task_id}/files — Adjunta una carga verificada a una tarea en espera POST /v1/tasks/{task_id}/process — Encolar y medir una tarea de documento GET /v1/tasks/{task_id}/quote — Estimar créditos HQ para una tarea en espera desde cargas verificadas POST /v1/tasks/{task_id}/uploads — Crear un ticket de carga para una tarea POST /v1/tasks/{task_id}/uploads/{upload_id}/complete — Sella un PDF cargado y adjúntalo a la tarea GET /v1/webhooks — Listar solo las suscripciones webhook de este proyecto POST /v1/webhooks — Suscríbete a eventos de cliente firmado con alcance de proyecto GET /v1/webhooks/deliveries — Inspecciona estados de entrega con alcance sin cargas confidenciales POST /v1/webhooks/deliveries/{delivery_id}/replay — Reproduce entrega fallida después de corregir el receptor DELETE /v1/webhooks/{subscription_id} — Revoca una suscripción de webhook con alcance de proyecto POST /v1/webhooks/{subscription_id}/rotate — Rotar secreto; revelar reemplazo una vez POST /v1/webhooks/{subscription_id}/test — Encolar un evento de prueba de suscripción sintética GET /v1/workspace/documents — Listar documentos POST /v1/workspace/documents — Registrar documento DELETE /v1/workspace/documents/{document_id} — Eliminar documento GET /v1/workspace/documents/{document_id} — Obtener documento PATCH /v1/workspace/documents/{document_id} — Actualizar documento GET /v1/workspace/documents/{document_id}/activity — Actividad del documento GET /v1/workspace/documents/{document_id}/handoff — Opciones de entrega POST /v1/workspace/documents/{document_id}/handoff/ai — Traspaso a ia POST /v1/workspace/documents/{document_id}/handoff/signing — Transferencia a firma POST /v1/workspace/documents/{document_id}/handoff/task — Transferencia a tarea GET /v1/workspace/documents/{document_id}/preview — Vista previa del documento GET /v1/workspace/documents/{document_id}/preview-url — URL de vista previa del documento PUT /v1/workspace/documents/{document_id}/retention — Establecer retención Esquema incluido Disponibilidad restringida Ver tu cartera compartida de créditos HQ
Solicitar contrato — instantánea de OpenAPI registrada
Autenticación: APIKeyHeader · Respuestas documentadas: 200, 422
No se declaró cuerpo de solicitud JSON.
Laboratorio API Autenticado
Solo lectura · Sin consumo de créditos Ejecutar solicitudes GET seguras seleccionadas contra la API PDFHQ publicada. Una clave de proyecto se mantiene solo en la memoria de esta pestaña. Nunca pegue credenciales de proveedor, credenciales de pago o una clave de producción en una computadora compartida.
# Fill placeholders with account-owned IDs and valid values; review the schema before sending.
# Server-side only. No API key is sent to signed storage hosts.
curl -q --fail-with-body --proto '=https' --max-redirs 0 \
-X GET 'https://api.pdfhq.io/v1/ai/billing/balance' \
-H "x-api-key: ${PDFHQ_API_KEY:?set PDFHQ_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 ejemplos requieren edición antes de usar y no se prueban automáticamente contra una API en ejecución.
SDKs y flujos de trabajo verificados
Los SDK descargables de diez idiomas actualmente cubren solo API de tareas , no la superficie completa de IA, firma o espacio de trabajo. La generación de servicio completo requiere un contrato OpenAPI verificado en tiempo de ejecución.