PDFLean
Referencia de la API

API de Workflows

Todos los endpoints requieren una sesión iniciada (cookie) a menos que se indique lo contrario. Las respuestas son JSON: { ok: true, data } o { ok: false, error }. Errores comunes: 400 validación, 401 no autenticado, 403 prohibido, 404 no encontrado, 429 límite de peticiones, 502/503 upstream. Los endpoints públicos /api/v1 se autentican con Authorization: Bearer pdflean_… y deben enviar un tipo de contenido JSON.

En esta página

Flujos de trabajo

MétodoRutaDescripción
GET/api/workflowsListar sus flujos de trabajo
POST/api/workflowsCrear un flujo de trabajo (borrador)
GET/api/workflows/:idObtener un flujo de trabajo
PUT/api/workflows/:idActualizar un flujo de trabajo (borrador, versión+1)
DELETE/api/workflows/:idEliminar un flujo de trabajo
POST/api/workflows/:id/publishPublicar una versión
GET/api/workflows/:id/versionsListar versiones
POST/api/workflows/:id/versions/:version/restoreRestaurar una versión

Disparadores y hooks

MétodoRutaDescripción
GET/api/workflows/triggersListar disparadores
POST/api/workflows/triggersCrear un disparador (webhook/programación/email/drive)
POST/api/workflows/triggers/:id/runEjecutar un disparador ahora
DELETE/api/workflows/triggers/:idEliminar un disparador
POST/api/workflows/hook/:tokenWebhook entrante (autenticación por token, sin sesión; cuerpo JSON)

Ejecuciones y revisiones

MétodoRutaDescripción
POST/api/workflows/runsCrear una ejecución (en cola)
GET/api/workflows/runsListar ejecuciones
GET/api/workflows/runs/:idDetalles de la ejecución y pasos
POST/api/workflows/runs/:id/retryReintentar una ejecución fallida/en cola
GET/api/workflows/reviewsRevisiones humanas pendientes
POST/api/workflows/reviews/:idAprobar/rechazar una revisión

Puente en la nube

MétodoRutaDescripción
GET/api/workflows/cloud/statusEstado del puente de VPS independiente
POST/api/workflows/cloud/convertOffice → PDF vía VPS independiente (LibreOffice)
POST/api/workflows/cloud/ocrOCR vía VPS independiente (Tesseract)
POST/api/workflows/cloud/extractExtraer campos de factura/genéricos de un PDF (pdfjs + reglas)

Archivo y retención

MétodoRutaDescripción
GET/api/workflows/archiveListar documentos archivados y integridad de la cadena
POST/api/workflows/archiveArchivar un documento (base64, cadena de hash SHA-256)
GET/api/workflows/archive/:id/verifyVerificar la cadena de hash del archivo
GET/api/workflows/archive/exportExportar CSV de auditoría del archivo (incluye tombstones)
POST/api/workflows/archive/:id/holdEstablecer/quitar retención legal
POST/api/workflows/archive/:id/complianceHabilitar bloqueo de cumplimiento WORM irreversible
DELETE/api/workflows/archive/:idEliminar un archivo (bloqueado bajo retención legal)

API pública v1

MétodoRutaDescripción
GET/api/v1/openapi.jsonEspecificación OpenAPI 3.1 (público, sin autenticación)
GET/api/v1/mePropietario actual de la clave API (clave Bearer)
GET/api/v1/usagePanel de uso: saldo, historial de 30 días, llamadas recientes
GET/api/v1/workflowsListar flujos de trabajo (alcance workflow.read)
GET/api/v1/workflows/:idObtener un flujo de trabajo (alcance workflow.read)
POST/api/v1/workflows/:id/runPoner en cola una ejecución (alcance workflow.run)
GET/api/v1/runsListar ejecuciones (alcance workflow.read)
POST/api/v1/pdf/mergeCombinar PDFs (alcance pdf.merge; 2–10 archivos en base64)
POST/api/v1/pdf/splitConservar páginas seleccionadas (alcance pdf.split; rangos como "1-3,5")
POST/api/v1/pdf/compressComprimir estructuralmente un PDF (alcance pdf.compress)
GET/api/v1/jobs/:idEstado del trabajo (gratis)
GET/api/v1/jobs/:id/downloadDescargar el resultado de un trabajo (gratis)
POST/api/v1/convert/officeConvertir documentos Office/ODF (alcance pdf.convert)
POST/api/v1/convert/linearizeLinearizar un PDF para una vista web rápida (alcance pdf.convert)
POST/api/v1/convert/typstCompilar código fuente Typst/Markdown a PDF (alcance pdf.convert)
POST/api/v1/ocrAplicar OCR a un PDF escaneado para hacerlo buscable (alcance pdf.ocr)
POST/api/v1/ocr/textAplicar OCR a una sola imagen para obtener texto (alcance pdf.ocr)
POST/api/v1/validate/pdfaVerificación de conformidad PDF/A (alcance pdf.validate)
POST/api/v1/validate/pdfuaVerificación de accesibilidad PDF/UA (alcance pdf.validate)
POST/api/v1/validate/signatureInforme de verificación de firma digital (alcance pdf.validate)
POST/api/v1/signFirma digital PAdES (alcance pdf.sign; par de claves PEM opcional)
POST/api/v1/redactRedacción real de coincidencias o áreas de texto (alcance pdf.redact)
POST/api/v1/extractExtracción de campos basada en texto y reglas (alcance pdf.extract)
POST/api/v1/doclingAnálisis de diseño estructurado mediante Docling (alcance pdf.extract)
POST/api/v1/scan/piiEscanear texto en busca de información personal (alcance pii.detect)

Credit consumption

Member credits refresh each billing cycle (no rollover) and are spent before purchased credits. Credits are $0.001 each.

Top up API credits in your account (from $5, never expires)

MethodEndpointCredits
GET/jobs/:id0 per call
GET/jobs/:id/download0 per call
GET/me0 per call
GET/runs0 per call
GET/usage0 per call
GET/workflows0 per call
GET/workflows/:id0 per call
POST/ai/chat3 per call
POST/ai/extract5 per call
POST/ai/pii-detect4 per call
POST/ai/summarize3 per call
POST/ai/translate3 per call
POST/convert/linearize1 per call
POST/convert/office2 per call
POST/convert/typst1 per call
POST/docling3 per call
POST/extract2 per call
POST/ocr3 per page
POST/ocr/text1 per call
POST/pdf/compress1 per call
POST/pdf/merge1 per call
POST/pdf/split1 per call
POST/redact3 per call
POST/scan/pii2 per call
POST/sign5 per envelope
POST/validate/pdfa2 per call
POST/validate/pdfua2 per call
POST/validate/signature2 per call
POST/workflows/:id/run1 per call
ai.chat2 per call
convert.html_to_pdf4 per page
convert.office_to_pdf10 per page
convert.pdf_to_office12 per page
convert.pdfa8 per page
esign.envelope750 per envelope
pdf.ocr3 per page
pdf.ocr.high8 per page