PDFLean
Справочник по API

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

Все конечные точки требуют авторизованного сеанса (cookie), если не указано иное. Ответы в формате JSON: { ok: true, data } или { ok: false, error }. Распространенные ошибки: 400 ошибка валидации, 401 не аутентифицирован, 403 доступ запрещен, 404 не найдено, 429 ограничение частоты запросов, 502/503 ошибка вышестоящего сервера. Публичные конечные точки /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Создать триггер (вебхук/расписание/email/диск)
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Список рабочих процессов (область workflow.read)
GET/api/v1/workflows/:idПолучить рабочий процесс (область workflow.read)
POST/api/v1/workflows/:id/runПоставить запуск в очередь (область workflow.run)
GET/api/v1/runsСписок запусков (область workflow.read)
POST/api/v1/pdf/mergeОбъединить PDF (область pdf.merge; 2–10 файлов в base64)
POST/api/v1/pdf/splitОставить выбранные страницы (область pdf.split; диапазоны вида "1-3,5")
POST/api/v1/pdf/compressСтруктурно сжать PDF (область pdf.compress)
GET/api/v1/jobs/:idСтатус задания (бесплатно)
GET/api/v1/jobs/:id/downloadСкачать результат задания (бесплатно)
POST/api/v1/convert/officeПреобразовать документы Office/ODF (область pdf.convert)
POST/api/v1/convert/linearizeЛинеаризовать PDF для быстрого просмотра в вебе (область pdf.convert)
POST/api/v1/convert/typstСкомпилировать исходный код Typst/Markdown в PDF (область pdf.convert)
POST/api/v1/ocrРаспознать отсканированный PDF в поисковый PDF (область pdf.ocr)
POST/api/v1/ocr/textРаспознать одно изображение в текст (область pdf.ocr)
POST/api/v1/validate/pdfaПроверка соответствия PDF/A (область pdf.validate)
POST/api/v1/validate/pdfuaПроверка доступности PDF/UA (область pdf.validate)
POST/api/v1/validate/signatureОтчёт о проверке цифровой подписи (область pdf.validate)
POST/api/v1/signЦифровая подпись PAdES (область pdf.sign; необязательная пара ключей PEM)
POST/api/v1/redactПолное редактирование совпадений текста или областей (область pdf.redact)
POST/api/v1/extractИзвлечение полей на основе текста и правил (область pdf.extract)
POST/api/v1/doclingСтруктурированный разбор макета с помощью Docling (область pdf.extract)
POST/api/v1/scan/piiСканировать текст на наличие персональных данных (область 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