PDFLean
Referência da API

API de Workflows

Todos os endpoints exigem uma sessão autenticada (cookie), salvo indicação em contrário. As respostas são JSON: { ok: true, data } ou { ok: false, error }. Erros comuns: 400 validação, 401 não autenticado, 403 proibido, 404 não encontrado, 429 limite de taxa excedido, 502/503 upstream. Os endpoints públicos /api/v1 se autenticam com Authorization: Bearer pdflean_… e devem enviar content type JSON.

Nesta página

Fluxos de trabalho

MétodoCaminhoDescrição
GET/api/workflowsListar seus fluxos de trabalho
POST/api/workflowsCriar um fluxo de trabalho (rascunho)
GET/api/workflows/:idObter um fluxo de trabalho
PUT/api/workflows/:idAtualizar um fluxo de trabalho (rascunho, versão+1)
DELETE/api/workflows/:idExcluir um fluxo de trabalho
POST/api/workflows/:id/publishPublicar uma versão
GET/api/workflows/:id/versionsListar versões
POST/api/workflows/:id/versions/:version/restoreRestaurar uma versão

Gatilhos e Hooks

MétodoCaminhoDescrição
GET/api/workflows/triggersListar gatilhos
POST/api/workflows/triggersCriar um gatilho (webhook/agendamento/e-mail/drive)
POST/api/workflows/triggers/:id/runExecutar um gatilho agora
DELETE/api/workflows/triggers/:idExcluir um gatilho
POST/api/workflows/hook/:tokenWebhook de entrada (autenticação por token, sem sessão; corpo JSON)

Execuções e Revisões

MétodoCaminhoDescrição
POST/api/workflows/runsCriar uma execução (na fila)
GET/api/workflows/runsListar execuções
GET/api/workflows/runs/:idDetalhes da execução e etapas
POST/api/workflows/runs/:id/retryTentar novamente uma execução com falha/na fila
GET/api/workflows/reviewsRevisões humanas pendentes
POST/api/workflows/reviews/:idAprovar/rejeitar uma revisão

Ponte de Nuvem

MétodoCaminhoDescrição
GET/api/workflows/cloud/statusStatus da ponte VPS independente
POST/api/workflows/cloud/convertOffice → PDF via VPS independente (LibreOffice)
POST/api/workflows/cloud/ocrOCR via VPS independente (Tesseract)
POST/api/workflows/cloud/extractExtrair campos de fatura/genéricos de um PDF (pdfjs + regras)

Arquivamento e Retenção

MétodoCaminhoDescrição
GET/api/workflows/archiveListar documentos arquivados e integridade da cadeia
POST/api/workflows/archiveArquivar um documento (base64, cadeia de hash SHA-256)
GET/api/workflows/archive/:id/verifyVerificar a cadeia de hashes do arquivamento
GET/api/workflows/archive/exportExportar CSV de auditoria do arquivamento (inclui registros de exclusão/tombstones)
POST/api/workflows/archive/:id/holdDefinir/remover retenção legal
POST/api/workflows/archive/:id/complianceAtivar bloqueio de conformidade WORM irreversível
DELETE/api/workflows/archive/:idExcluir um arquivamento (bloqueado sob retenção legal)

API Pública v1

MétodoCaminhoDescrição
GET/api/v1/openapi.jsonEspecificação OpenAPI 3.1 (pública, sem autenticação)
GET/api/v1/meProprietário atual da chave de API (chave Bearer)
GET/api/v1/usagePainel de uso: saldo, histórico de 30 dias, chamadas recentes
GET/api/v1/workflowsListar fluxos de trabalho (escopo workflow.read)
GET/api/v1/workflows/:idObter um fluxo de trabalho (escopo workflow.read)
POST/api/v1/workflows/:id/runEnfileirar uma execução (escopo workflow.run)
GET/api/v1/runsListar execuções (escopo workflow.read)
POST/api/v1/pdf/mergeMesclar PDFs (escopo pdf.merge; 2 a 10 arquivos em base64)
POST/api/v1/pdf/splitManter páginas selecionadas (escopo pdf.split; intervalos como "1-3,5")
POST/api/v1/pdf/compressCompactar estruturalmente um PDF (escopo pdf.compress)
GET/api/v1/jobs/:idStatus do trabalho (gratuito)
GET/api/v1/jobs/:id/downloadBaixar o resultado de um trabalho (gratuito)
POST/api/v1/convert/officeConverter documentos Office/ODF (escopo pdf.convert)
POST/api/v1/convert/linearizeLinearizar um PDF para visualização rápida na web (escopo pdf.convert)
POST/api/v1/convert/typstCompilar código-fonte Typst/Markdown para PDF (escopo pdf.convert)
POST/api/v1/ocrAplicar OCR em um PDF digitalizado para um PDF pesquisável (escopo pdf.ocr)
POST/api/v1/ocr/textAplicar OCR em uma única imagem para texto (escopo pdf.ocr)
POST/api/v1/validate/pdfaVerificação de conformidade PDF/A (escopo pdf.validate)
POST/api/v1/validate/pdfuaVerificação de acessibilidade PDF/UA (escopo pdf.validate)
POST/api/v1/validate/signatureRelatório de verificação de assinatura digital (escopo pdf.validate)
POST/api/v1/signAssinatura digital PAdES (escopo pdf.sign; par de chaves PEM opcional)
POST/api/v1/redactRedação verdadeira de correspondências de texto ou áreas (escopo pdf.redact)
POST/api/v1/extractExtração de campos baseada em texto e regras (escopo pdf.extract)
POST/api/v1/doclingAnálise de layout estruturado via Docling (escopo pdf.extract)
POST/api/v1/scan/piiVerificar texto em busca de informações pessoais (escopo 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