PDFLean
API-referens

Arbetsflödes-API

Alla slutpunkter kräver en inloggad session (cookie) om inget annat anges. Svaren är JSON: { ok: true, data } eller { ok: false, error }. Vanliga fel: 400 validering, 401 oautentiserad, 403 förbjuden, 404 hittades inte, 429 hastighetsbegränsad, 502/503 uppströms. Offentliga /api/v1-slutpunkter autentiseras med Authorization: Bearer pdflean_… och måste skicka JSON som innehållstyp.

På den här sidan

Arbetsflöden

MetodSökvägBeskrivning
GET/api/workflowsLista dina arbetsflöden
POST/api/workflowsSkapa ett arbetsflöde (utkast)
GET/api/workflows/:idHämta ett arbetsflöde
PUT/api/workflows/:idUppdatera ett arbetsflöde (utkast, version+1)
DELETE/api/workflows/:idTa bort ett arbetsflöde
POST/api/workflows/:id/publishPublicera en version
GET/api/workflows/:id/versionsLista versioner
POST/api/workflows/:id/versions/:version/restoreÅterställ en version

Triggers & krokar

MetodSökvägBeskrivning
GET/api/workflows/triggersLista triggers
POST/api/workflows/triggersSkapa en trigger (webhook/schema/e-post/drive)
POST/api/workflows/triggers/:id/runKör en trigger nu
DELETE/api/workflows/triggers/:idTa bort en trigger
POST/api/workflows/hook/:tokenInkommande webhook (token-autentisering, ingen session; JSON-brödtext)

Körningar & Granskningar

MetodSökvägBeskrivning
POST/api/workflows/runsSkapa en körning (köad)
GET/api/workflows/runsLista körningar
GET/api/workflows/runs/:idKörningsdetaljer och steg
POST/api/workflows/runs/:id/retryFörsök igen med en misslyckad/köad körning
GET/api/workflows/reviewsVäntande mänskliga granskningar
POST/api/workflows/reviews/:idGodkänn/avvisa en granskning

Molnbrygga

MetodSökvägBeskrivning
GET/api/workflows/cloud/statusStatus för fristående VPS-brygga
POST/api/workflows/cloud/convertOffice → PDF via fristående VPS (LibreOffice)
POST/api/workflows/cloud/ocrOCR via fristående VPS (Tesseract)
POST/api/workflows/cloud/extractExtrahera faktura-/generiska fält från PDF (pdfjs + regler)

Arkiv & lagringstid

MetodSökvägBeskrivning
GET/api/workflows/archiveLista arkiverade dokument och kedjeintegritet
POST/api/workflows/archiveArkivera ett dokument (base64, SHA-256-hashkedja)
GET/api/workflows/archive/:id/verifyVerifiera arkivets hashkedja
GET/api/workflows/archive/exportExportera CSV för arkivrevision (inkluderar tombstones)
POST/api/workflows/archive/:id/holdAnge/ta bort juridiskt bevarande
POST/api/workflows/archive/:id/complianceAktivera oåterkalleligt WORM-efterlevnadslås
DELETE/api/workflows/archive/:idTa bort ett arkiv (blockerat under juridiskt bevarande)

Offentligt API v1

MetodSökvägBeskrivning
GET/api/v1/openapi.jsonOpenAPI 3.1-specifikation (publik, ingen auth)
GET/api/v1/meNuvarande ägare av API-nyckel (Bearer-nyckel)
GET/api/v1/usageAnvändningspanel: saldo, 30-dagarshistorik, senaste anrop
GET/api/v1/workflowsLista arbetsflöden (scope workflow.read)
GET/api/v1/workflows/:idHämta ett arbetsflöde (scope workflow.read)
POST/api/v1/workflows/:id/runKöa en körning (scope workflow.run)
GET/api/v1/runsLista körningar (scope workflow.read)
POST/api/v1/pdf/mergeSammanfoga PDF-filer (scope pdf.merge; 2–10 base64-filer)
POST/api/v1/pdf/splitBehåll valda sidor (scope pdf.split; intervall som "1-3,5")
POST/api/v1/pdf/compressStrukturell komprimering av en PDF (scope pdf.compress)
GET/api/v1/jobs/:idJobbstatus (gratis)
GET/api/v1/jobs/:id/downloadLadda ner ett jobbresultat (gratis)
POST/api/v1/convert/officeKonvertera Office/ODF-dokument (scope pdf.convert)
POST/api/v1/convert/linearizeLinearera en PDF för snabb webbvisning (scope pdf.convert)
POST/api/v1/convert/typstKompilera Typst/Markdown-källkod till PDF (scope pdf.convert)
POST/api/v1/ocrOCR-skanna en inskannad PDF till en sökbar PDF (scope pdf.ocr)
POST/api/v1/ocr/textOCR-skanna en enskild bild till text (scope pdf.ocr)
POST/api/v1/validate/pdfaPDF/A-kompatibilitetskontroll (scope pdf.validate)
POST/api/v1/validate/pdfuaPDF/UA-tillgänglighetskontroll (scope pdf.validate)
POST/api/v1/validate/signatureVerifieringsrapport för digital signatur (scope pdf.validate)
POST/api/v1/signPAdES digital signatur (scope pdf.sign; valfritt PEM-nyckelpar)
POST/api/v1/redactSann redigering av textmatchningar eller områden (scope pdf.redact)
POST/api/v1/extractText- och regelbaserad fältextraktion (scope pdf.extract)
POST/api/v1/doclingStrukturerad layoutanalys via Docling (scope pdf.extract)
POST/api/v1/scan/piiSkanna text efter personlig information (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