PDFLean
API-Referenz

Workflow-API

Alle Endpunkte erfordern eine angemeldete Sitzung (Cookie), sofern nicht anders angegeben. Antworten sind JSON: { ok: true, data } oder { ok: false, error }. Häufige Fehler: 400 Validierung, 401 nicht authentifiziert, 403 verboten, 404 nicht gefunden, 429 ratenbegrenzt, 502/503 Upstream. Öffentliche /api/v1-Endpunkte authentifizieren sich mit Authorization: Bearer pdflean_… und müssen einen JSON-Inhaltstyp senden.

Auf dieser Seite

Workflows

MethodePfadBeschreibung
GET/api/workflowsIhre Workflows auflisten
POST/api/workflowsWorkflow erstellen (Entwurf)
GET/api/workflows/:idWorkflow abrufen
PUT/api/workflows/:idWorkflow aktualisieren (Entwurf, Version+1)
DELETE/api/workflows/:idWorkflow löschen
POST/api/workflows/:id/publishVersion veröffentlichen
GET/api/workflows/:id/versionsVersionen auflisten
POST/api/workflows/:id/versions/:version/restoreVersion wiederherstellen

Trigger & Hooks

MethodePfadBeschreibung
GET/api/workflows/triggersTrigger auflisten
POST/api/workflows/triggersTrigger erstellen (Webhook/Zeitplan/E-Mail/Drive)
POST/api/workflows/triggers/:id/runTrigger jetzt ausführen
DELETE/api/workflows/triggers/:idTrigger löschen
POST/api/workflows/hook/:tokenEingehender Webhook (Token-Auth, keine Sitzung; JSON-Body)

Durchläufe & Überprüfungen

MethodePfadBeschreibung
POST/api/workflows/runsDurchlauf erstellen (in Warteschlange)
GET/api/workflows/runsDurchläufe auflisten
GET/api/workflows/runs/:idDetails und Schritte des Durchlaufs
POST/api/workflows/runs/:id/retryFehlgeschlagenen/eingereihten Durchlauf wiederholen
GET/api/workflows/reviewsAusstehende manuelle Überprüfungen
POST/api/workflows/reviews/:idEine Überprüfung genehmigen/ablehnen

Cloud-Bridge

MethodePfadBeschreibung
GET/api/workflows/cloud/statusStatus der eigenständigen VPS-Bridge
POST/api/workflows/cloud/convertOffice → PDF über eigenständigen VPS (LibreOffice)
POST/api/workflows/cloud/ocrOCR über eigenständigen VPS (Tesseract)
POST/api/workflows/cloud/extractRechnungs-/allgemeine Felder aus PDF extrahieren (pdfjs + Regeln)

Archiv & Aufbewahrung

MethodePfadBeschreibung
GET/api/workflows/archiveArchivierte Dokumente + Kettenintegrität auflisten
POST/api/workflows/archiveEin Dokument archivieren (base64, SHA-256-Hash-Kette)
GET/api/workflows/archive/:id/verifyDie Archiv-Hash-Kette überprüfen
GET/api/workflows/archive/exportArchiv-Audit-CSV exportieren (enthält Tombstones)
POST/api/workflows/archive/:id/holdLegal Hold setzen/aufheben
POST/api/workflows/archive/:id/complianceIrreversible WORM-Compliance-Sperre aktivieren
DELETE/api/workflows/archive/:idEin Archiv löschen (unter Legal Hold blockiert)

Öffentliche API v1

MethodePfadBeschreibung
GET/api/v1/openapi.jsonOpenAPI 3.1-Spezifikation (öffentlich, keine Authentifizierung)
GET/api/v1/meAktueller API-Schlüssel-Inhaber (Bearer-Schlüssel)
GET/api/v1/usageNutzungs-Dashboard: Guthaben, 30-Tage-Verlauf, letzte Anrufe
GET/api/v1/workflowsWorkflows auflisten (Umfang workflow.read)
GET/api/v1/workflows/:idEinen Workflow abrufen (Umfang workflow.read)
POST/api/v1/workflows/:id/runEinen Lauf in die Warteschlange stellen (Umfang workflow.run)
GET/api/v1/runsLäufe auflisten (Umfang workflow.read)
POST/api/v1/pdf/mergePDFs zusammenführen (Umfang pdf.merge; 2–10 Base64-Dateien)
POST/api/v1/pdf/splitAusgewählte Seiten behalten (Umfang pdf.split; Bereiche wie "1-3,5")
POST/api/v1/pdf/compressPDF strukturell komprimieren (Umfang pdf.compress)
GET/api/v1/jobs/:idJob-Status (kostenlos)
GET/api/v1/jobs/:id/downloadEin Job-Ergebnis herunterladen (kostenlos)
POST/api/v1/convert/officeOffice/ODF-Dokumente konvertieren (Umfang pdf.convert)
POST/api/v1/convert/linearizePDF für schnelle Webansicht linearisieren (Umfang pdf.convert)
POST/api/v1/convert/typstTypst/Markdown-Quelltext zu PDF kompilieren (Umfang pdf.convert)
POST/api/v1/ocrGescannte PDF per OCR in durchsuchbare PDF umwandeln (Umfang pdf.ocr)
POST/api/v1/ocr/textEinzelnes Bild per OCR zu Text (Umfang pdf.ocr)
POST/api/v1/validate/pdfaPDF/A-Konformitätsprüfung (Umfang pdf.validate)
POST/api/v1/validate/pdfuaPDF/UA-Barrierefreiheitsprüfung (Umfang pdf.validate)
POST/api/v1/validate/signatureBericht zur digitalen Signaturprüfung (Umfang pdf.validate)
POST/api/v1/signPAdES digitale Signatur (Umfang pdf.sign; optionales PEM-Schlüsselpaar)
POST/api/v1/redactEchtes Schwärzen von Textübereinstimmungen oder Bereichen (Umfang pdf.redact)
POST/api/v1/extractText- und regelbasierte Feldextraktion (Umfang pdf.extract)
POST/api/v1/doclingStrukturierte Layout-Analyse via Docling (Umfang pdf.extract)
POST/api/v1/scan/piiText auf persönliche Informationen scannen (Umfang 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