PDFLean
API-referentie

Werkstroom-API

Alle endpoints vereisen een ingelogde sessie (cookie) tenzij anders vermeld. Antwoorden zijn JSON: { ok: true, data } of { ok: false, error }. Veelvoorkomende fouten: 400 validatie, 401 niet geauthenticeerd, 403 verboden, 404 niet gevonden, 429 snelheidsbeperkt, 502/503 upstream. Publieke /api/v1 endpoints authenticeren met Authorization: Bearer pdflean_… en moeten een JSON-contenttype verzenden.

Op deze pagina

Werkstromen

MethodePadBeschrijving
GET/api/workflowsToon uw workflows
POST/api/workflowsMaak een workflow aan (concept)
GET/api/workflows/:idHaal een workflow op
PUT/api/workflows/:idWerk een workflow bij (concept, versie+1)
DELETE/api/workflows/:idVerwijder een workflow
POST/api/workflows/:id/publishPubliceer een versie
GET/api/workflows/:id/versionsToon versies
POST/api/workflows/:id/versions/:version/restoreHerstel een versie

Triggers & Hooks

MethodePadBeschrijving
GET/api/workflows/triggersToon triggers
POST/api/workflows/triggersMaak een trigger aan (webhook/schema/e-mail/drive)
POST/api/workflows/triggers/:id/runVoer nu een trigger uit
DELETE/api/workflows/triggers/:idVerwijder een trigger
POST/api/workflows/hook/:tokenInkomende webhook (token-auth, geen sessie; JSON-body)

Runs & Beoordelingen

MethodePadBeschrijving
POST/api/workflows/runsEen run aanmaken (in wachtrij)
GET/api/workflows/runsRuns weergeven
GET/api/workflows/runs/:idRun-details en stappen
POST/api/workflows/runs/:id/retryEen mislukte/wachtende run opnieuw proberen
GET/api/workflows/reviewsOpenstaande menselijke beoordelingen
POST/api/workflows/reviews/:idEen beoordeling goedkeuren/afwijzen

Cloudbrug

MethodePadBeschrijving
GET/api/workflows/cloud/statusStatus standalone VPS-bridge
POST/api/workflows/cloud/convertOffice → PDF via standalone VPS (LibreOffice)
POST/api/workflows/cloud/ocrOCR via standalone VPS (Tesseract)
POST/api/workflows/cloud/extractFactuur/generieke velden extraheren uit PDF (pdfjs + regels)

Archief & Retentie

MethodePadBeschrijving
GET/api/workflows/archiveToon gearchiveerde documenten + ketenintegriteit
POST/api/workflows/archiveArchiveer een document (base64, SHA-256 hash-keten)
GET/api/workflows/archive/:id/verifyVerifieer de archief-hashketen
GET/api/workflows/archive/exportExporteer archief audit CSV (inclusief tombstones)
POST/api/workflows/archive/:id/holdJuridische bewaring instellen/opheffen
POST/api/workflows/archive/:id/complianceSchakel onomkeerbare WORM compliance-vergrendeling in
DELETE/api/workflows/archive/:idVerwijder een archief (geblokkeerd onder juridische bewaring)

Publieke API v1

MethodePadBeschrijving
GET/api/v1/openapi.jsonOpenAPI 3.1 specificatie (publiek, geen authenticatie)
GET/api/v1/meHuidige eigenaar van API-sleutel (Bearer-sleutel)
GET/api/v1/usageGebruiksdashboard: saldo, geschiedenis van 30 dagen, recente aanroepen
GET/api/v1/workflowsWorkflows weergeven (scope workflow.read)
GET/api/v1/workflows/:idEen workflow ophalen (scope workflow.read)
POST/api/v1/workflows/:id/runEen run in de wachtrij plaatsen (scope workflow.run)
GET/api/v1/runsRuns weergeven (scope workflow.read)
POST/api/v1/pdf/mergePDF's samenvoegen (scope pdf.merge; 2–10 base64-bestanden)
POST/api/v1/pdf/splitGeselecteerde pagina's behouden (scope pdf.split; bereiken zoals "1-3,5")
POST/api/v1/pdf/compressEen PDF structureel comprimeren (scope pdf.compress)
GET/api/v1/jobs/:idTaakstatus (gratis)
GET/api/v1/jobs/:id/downloadEen taakresultaat downloaden (gratis)
POST/api/v1/convert/officeOffice/ODF-documenten converteren (scope pdf.convert)
POST/api/v1/convert/linearizeEen PDF lineariseren voor snelle webweergave (scope pdf.convert)
POST/api/v1/convert/typstTypst/Markdown-broncode compileren naar PDF (scope pdf.convert)
POST/api/v1/ocrOCR toepassen op een gescande PDF naar een doorzoekbare PDF (scope pdf.ocr)
POST/api/v1/ocr/textOCR toepassen op een enkele afbeelding naar tekst (scope pdf.ocr)
POST/api/v1/validate/pdfaPDF/A-nalevingscontrole (scope pdf.validate)
POST/api/v1/validate/pdfuaPDF/UA-toegankelijkheidscontrole (scope pdf.validate)
POST/api/v1/validate/signatureRapport over verificatie van digitale handtekeningen (scope pdf.validate)
POST/api/v1/signPAdES digitale handtekening (scope pdf.sign; optioneel PEM-sleutelpaar)
POST/api/v1/redactEchte redactie van tekstovereenkomsten of gebieden (scope pdf.redact)
POST/api/v1/extractTekst- en op regels gebaseerde veldextractie (scope pdf.extract)
POST/api/v1/doclingGestructureerde lay-outparsing via Docling (scope pdf.extract)
POST/api/v1/scan/piiTekst scannen op persoonlijke informatie (scope 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