PDFLean
Dokumentacja API

API przepływu pracy

Wszystkie punkty końcowe wymagają zalogowanej sesji (cookie), chyba że zaznaczono inaczej. Odpowiedzi to JSON: { ok: true, data } lub { ok: false, error }. Typowe błędy: 400 błąd walidacji, 401 brak uwierzytelnienia, 403 brak uprawnień, 404 nie znaleziono, 429 ograniczenie częstotliwości żądań, 502/503 błąd usługi nadrzędnej. Publiczne punkty końcowe /api/v1 uwierzytelniają się za pomocą Authorization: Bearer pdflean_… i muszą wysyłać typ zawartości JSON.

Na tej stronie

Przepływy pracy

MetodaŚcieżkaOpis
GET/api/workflowsWyświetl swoje przepływy pracy
POST/api/workflowsUtwórz przepływ pracy (wersja robocza)
GET/api/workflows/:idPobierz przepływ pracy
PUT/api/workflows/:idZaktualizuj przepływ pracy (wersja robocza, wersja+1)
DELETE/api/workflows/:idUsuń przepływ pracy
POST/api/workflows/:id/publishOpublikuj wersję
GET/api/workflows/:id/versionsWyświetl wersje
POST/api/workflows/:id/versions/:version/restorePrzywróć wersję

Wyzwalacze i hooki

MetodaŚcieżkaOpis
GET/api/workflows/triggersWyświetl wyzwalacze
POST/api/workflows/triggersUtwórz wyzwalacz (webhook/harmonogram/e-mail/dysk)
POST/api/workflows/triggers/:id/runUruchom wyzwalacz teraz
DELETE/api/workflows/triggers/:idUsuń wyzwalacz
POST/api/workflows/hook/:tokenPrzychodzący webhook (uwierzytelnianie tokenem, bez sesji; treść JSON)

Uruchomienia i weryfikacje

MetodaŚcieżkaOpis
POST/api/workflows/runsUtwórz uruchomienie (w kolejce)
GET/api/workflows/runsLista uruchomień
GET/api/workflows/runs/:idSzczegóły uruchomienia + kroki
POST/api/workflows/runs/:id/retryPonów nieudane/zakolejkowane uruchomienie
GET/api/workflows/reviewsOczekujące weryfikacje przez człowieka
POST/api/workflows/reviews/:idZatwierdź/odrzuć weryfikację

Most chmurowy

MetodaŚcieżkaOpis
GET/api/workflows/cloud/statusStatus samodzielnego mostu VPS
POST/api/workflows/cloud/convertOffice → PDF przez samodzielny VPS (LibreOffice)
POST/api/workflows/cloud/ocrOCR przez samodzielny VPS (Tesseract)
POST/api/workflows/cloud/extractWyodrębnij pola faktury/ogólne z PDF (pdfjs + reguły)

Archiwum i retencja

MetodaŚcieżkaOpis
GET/api/workflows/archiveLista zarchiwizowanych dokumentów + spójność łańcucha
POST/api/workflows/archiveArchiwizuj dokument (base64, łańcuch skrótów SHA-256)
GET/api/workflows/archive/:id/verifyZweryfikuj łańcuch skrótów archiwum
GET/api/workflows/archive/exportEksportuj CSV z audytu archiwum (zawiera znaczniki usunięcia)
POST/api/workflows/archive/:id/holdUstaw/zdejmij blokadę prawną (legal hold)
POST/api/workflows/archive/:id/complianceWłącz nieodwracalną blokadę zgodności WORM
DELETE/api/workflows/archive/:idUsuń archiwum (zablokowane w przypadku blokady prawnej)

Publiczne API v1

MetodaŚcieżkaOpis
GET/api/v1/openapi.jsonSpecyfikacja OpenAPI 3.1 (publiczna, bez uwierzytelniania)
GET/api/v1/meAktualny właściciel klucza API (klucz Bearer)
GET/api/v1/usagePanel użycia: saldo, historia z 30 dni, ostatnie wywołania
GET/api/v1/workflowsLista workflowów (zakres workflow.read)
GET/api/v1/workflows/:idPobierz workflow (zakres workflow.read)
POST/api/v1/workflows/:id/runZakolejkowanie uruchomienia (zakres workflow.run)
GET/api/v1/runsLista uruchomień (zakres workflow.read)
POST/api/v1/pdf/mergeŁączenie plików PDF (zakres pdf.merge; 2–10 plików w base64)
POST/api/v1/pdf/splitZachowanie wybranych stron (zakres pdf.split; zakresy np. "1-3,5")
POST/api/v1/pdf/compressStrukturalna kompresja pliku PDF (zakres pdf.compress)
GET/api/v1/jobs/:idStatus zadania (bezpłatne)
GET/api/v1/jobs/:id/downloadPobranie wyniku zadania (bezpłatne)
POST/api/v1/convert/officeKonwersja dokumentów Office/ODF (zakres pdf.convert)
POST/api/v1/convert/linearizeLinearyzacja pliku PDF dla szybkiego podglądu w sieci (zakres pdf.convert)
POST/api/v1/convert/typstKompilacja kodu źródłowego Typst/Markdown do PDF (zakres pdf.convert)
POST/api/v1/ocrOCR zeskanowanego PDF do przeszukiwalnego PDF (zakres pdf.ocr)
POST/api/v1/ocr/textOCR pojedynczego obrazu do tekstu (zakres pdf.ocr)
POST/api/v1/validate/pdfaSprawdzenie zgodności PDF/A (zakres pdf.validate)
POST/api/v1/validate/pdfuaSprawdzenie dostępności PDF/UA (zakres pdf.validate)
POST/api/v1/validate/signatureRaport weryfikacji podpisu cyfrowego (zakres pdf.validate)
POST/api/v1/signPodpis cyfrowy PAdES (zakres pdf.sign; opcjonalna para kluczy PEM)
POST/api/v1/redactPrawdziwa redakcja dopasowań tekstu lub obszarów (zakres pdf.redact)
POST/api/v1/extractEkstrakcja pól na podstawie tekstu i reguł (zakres pdf.extract)
POST/api/v1/doclingStrukturalne przetwarzanie układu przez Docling (zakres pdf.extract)
POST/api/v1/scan/piiSkanowanie tekstu pod kątem danych osobowych (zakres 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