PDFLean
Довідник API

API робочих процесів

Усі кінцеві точки вимагають авторизованого сеансу (cookie), якщо не зазначено інше. Відповіді повертаються у форматі JSON: { ok: true, data } або { ok: false, error }. Типові помилки: 400 — помилка валідації, 401 — не автентифіковано, 403 — доступ заборонено, 404 — не знайдено, 429 — перевищено ліміт запитів, 502/503 — помилка upstream. Публічні кінцеві точки /api/v1 автентифікуються за допомогою Authorization: Bearer pdflean_… та мають надсилати тип вмісту JSON.

На цій сторінці

Робочі процеси

МетодШляхОпис
GET/api/workflowsСписок ваших робочих процесів
POST/api/workflowsСтворити робочий процес (чернетка)
GET/api/workflows/:idОтримати робочий процес
PUT/api/workflows/:idОновити робочий процес (чернетка, версія+1)
DELETE/api/workflows/:idВидалити робочий процес
POST/api/workflows/:id/publishОпублікувати версію
GET/api/workflows/:id/versionsСписок версій
POST/api/workflows/:id/versions/:version/restoreВідновити версію

Тригери та хуки

МетодШляхОпис
GET/api/workflows/triggersСписок тригерів
POST/api/workflows/triggersСтворити тригер (вебхук/розклад/електронна пошта/хмарний диск)
POST/api/workflows/triggers/:id/runЗапустити тригер зараз
DELETE/api/workflows/triggers/:idВидалити тригер
POST/api/workflows/hook/:tokenВхідний вебхук (автентифікація за токеном, без сеансу; тіло JSON)

Запуски та перевірки

МетодШляхОпис
POST/api/workflows/runsСтворити запуск (у черзі)
GET/api/workflows/runsСписок запусків
GET/api/workflows/runs/:idДеталі запуску та кроки
POST/api/workflows/runs/:id/retryПовторити невдалий запуск або запуск у черзі
GET/api/workflows/reviewsПеревірки, що очікують на розгляд людиною
POST/api/workflows/reviews/:idСхвалити/відхилити перевірку

Хмарний міст

МетодШляхОпис
GET/api/workflows/cloud/statusСтатус автономного мосту VPS
POST/api/workflows/cloud/convertOffice → PDF через автономний VPS (LibreOffice)
POST/api/workflows/cloud/ocrOCR через автономний VPS (Tesseract)
POST/api/workflows/cloud/extractВидобування полів рахунка/загальних полів із PDF (pdfjs + правила)

Архів та зберігання

МетодШляхОпис
GET/api/workflows/archiveСписок архівних документів та цілісність ланцюжка хешів
POST/api/workflows/archiveАрхівувати документ (base64, ланцюжок хешів SHA-256)
GET/api/workflows/archive/:id/verifyПеревірити ланцюжок хешів архіву
GET/api/workflows/archive/exportЕкспорт аудиторського CSV архіву (включає маркери видалення)
POST/api/workflows/archive/:id/holdВстановити/зняти юридичне утримання
POST/api/workflows/archive/:id/complianceУвімкнути незворотне WORM-блокування для відповідності нормам
DELETE/api/workflows/archive/:idВидалити архів (заблоковано під час юридичного утримання)

Публічний API v1

МетодШляхОпис
GET/api/v1/openapi.jsonСпецифікація OpenAPI 3.1 (публічна, без авторизації)
GET/api/v1/meПоточний власник API-ключа (Bearer-ключ)
GET/api/v1/usageПанель використання: баланс, історія за 30 днів, останні виклики
GET/api/v1/workflowsСписок робочих процесів (scope workflow.read)
GET/api/v1/workflows/:idОтримати робочий процес (scope workflow.read)
POST/api/v1/workflows/:id/runПоставити запуск у чергу (scope workflow.run)
GET/api/v1/runsСписок запусків (scope workflow.read)
POST/api/v1/pdf/mergeОб'єднання PDF-файлів (scope pdf.merge; 2–10 файлів у base64)
POST/api/v1/pdf/splitЗберегти вибрані сторінки (scope pdf.split; діапазони типу "1-3,5")
POST/api/v1/pdf/compressСтруктурне стиснення PDF (scope pdf.compress)
GET/api/v1/jobs/:idСтатус завдання (безкоштовно)
GET/api/v1/jobs/:id/downloadЗавантажити результат завдання (безкоштовно)
POST/api/v1/convert/officeКонвертація документів Office/ODF (scope pdf.convert)
POST/api/v1/convert/linearizeЛінеаризація PDF для швидкого перегляду у вебі (scope pdf.convert)
POST/api/v1/convert/typstКомпіляція Typst/Markdown у PDF (scope pdf.convert)
POST/api/v1/ocrOCR сканованого PDF у PDF з можливістю пошуку (scope pdf.ocr)
POST/api/v1/ocr/textOCR одного зображення у текст (scope pdf.ocr)
POST/api/v1/validate/pdfaПеревірка відповідності PDF/A (scope pdf.validate)
POST/api/v1/validate/pdfuaПеревірка доступності PDF/UA (scope pdf.validate)
POST/api/v1/validate/signatureЗвіт про перевірку цифрового підпису (scope pdf.validate)
POST/api/v1/signЦифровий підпис PAdES (scope pdf.sign; необов'язкова пара ключів PEM)
POST/api/v1/redactСправжнє редагування текстових збігів або областей (scope pdf.redact)
POST/api/v1/extractВидобування полів на основі тексту та правил (scope pdf.extract)
POST/api/v1/doclingСтруктурований розбір макета через Docling (scope pdf.extract)
POST/api/v1/scan/piiСканування тексту на персональну інформацію (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