PDFLean
Tài liệu tham khảo API

API Quy trình công việc

Tất cả các endpoint đều yêu cầu một phiên đã đăng nhập (cookie) trừ khi có ghi chú. Phản hồi là JSON: { ok: true, data } hoặc { ok: false, error }. Lỗi thường gặp: 400 tham số không hợp lệ, 401 chưa xác thực, 403 bị cấm, 404 không tìm thấy, 429 bị giới hạn tốc độ, 502/503 upstream. Các endpoint /api/v1 công khai xác thực bằng Authorization: Bearer pdflean_… và phải gửi loại nội dung JSON.

Trên trang này

Quy trình công việc

Phương thứcĐường dẫnMô tả
GET/api/workflowsLiệt kê các quy trình công việc của bạn
POST/api/workflowsTạo một quy trình công việc (bản nháp)
GET/api/workflows/:idLấy một quy trình công việc
PUT/api/workflows/:idCập nhật quy trình công việc (bản nháp, phiên bản+1)
DELETE/api/workflows/:idXóa quy trình công việc
POST/api/workflows/:id/publishXuất bản một phiên bản
GET/api/workflows/:id/versionsLiệt kê các phiên bản
POST/api/workflows/:id/versions/:version/restoreKhôi phục một phiên bản

Kích hoạt & Hooks

Phương thứcĐường dẫnMô tả
GET/api/workflows/triggersLiệt kê kích hoạt
POST/api/workflows/triggersTạo một kích hoạt (webhook/lịch trình/email/drive)
POST/api/workflows/triggers/:id/runChạy kích hoạt ngay
DELETE/api/workflows/triggers/:idXóa kích hoạt
POST/api/workflows/hook/:tokenWebhook nhận vào (xác thực bằng token, không cần phiên; nội dung JSON)

Lần chạy & Xét duyệt

Phương thứcĐường dẫnMô tả
POST/api/workflows/runsTạo một lần chạy (đang chờ hàng đợi)
GET/api/workflows/runsLiệt kê các lần chạy
GET/api/workflows/runs/:idChi tiết lần chạy + các bước
POST/api/workflows/runs/:id/retryThử lại một lần chạy thất bại/đang chờ
GET/api/workflows/reviewsCác xét duyệt của con người đang chờ
POST/api/workflows/reviews/:idPhê duyệt/từ chối xét duyệt

Cầu nối đám mây

Phương thứcĐường dẫnMô tả
GET/api/workflows/cloud/statusTrạng thái cầu nối VPS độc lập
POST/api/workflows/cloud/convertOffice → PDF qua VPS độc lập (LibreOffice)
POST/api/workflows/cloud/ocrOCR qua VPS độc lập (Tesseract)
POST/api/workflows/cloud/extractTrích xuất các trường hóa đơn/tổng quát từ PDF (pdfjs + rules)

Lưu trữ & Giữ lại

Phương thứcĐường dẫnMô tả
GET/api/workflows/archiveLiệt kê các tài liệu đã lưu trữ + tính toàn vẹn chuỗi
POST/api/workflows/archiveLưu trữ tài liệu (base64, chuỗi băm SHA-256)
GET/api/workflows/archive/:id/verifyXác minh chuỗi băm lưu trữ
GET/api/workflows/archive/exportXuất CSV kiểm toán lưu trữ (bao gồm cả bản ghi tombstone)
POST/api/workflows/archive/:id/holdĐặt/xóa tạm giữ pháp lý
POST/api/workflows/archive/:id/complianceBật khóa tuân thủ WORM không thể đảo ngược
DELETE/api/workflows/archive/:idXóa một bản lưu trữ (bị chặn khi đang tạm giữ pháp lý)

API công khai v1

Phương thứcĐường dẫnMô tả
GET/api/v1/openapi.jsonĐặc tả OpenAPI 3.1 (công khai, không cần xác thực)
GET/api/v1/meChủ sở hữu khóa API hiện tại (khóa Bearer)
GET/api/v1/usageBảng điều khiển sử dụng: số dư, lịch sử 30 ngày, các cuộc gọi gần đây
GET/api/v1/workflowsLiệt kê workflows (quyền workflow.read)
GET/api/v1/workflows/:idLấy một workflow (quyền workflow.read)
POST/api/v1/workflows/:id/runĐưa một lần chạy vào hàng đợi (quyền workflow.run)
GET/api/v1/runsLiệt kê các lần chạy (quyền workflow.read)
POST/api/v1/pdf/mergeGộp các PDF (quyền pdf.merge; 2–10 tệp base64)
POST/api/v1/pdf/splitGiữ lại các trang được chọn (quyền pdf.split; dải trang như "1-3,5")
POST/api/v1/pdf/compressNén cấu trúc một PDF (quyền pdf.compress)
GET/api/v1/jobs/:idTrạng thái công việc (miễn phí)
GET/api/v1/jobs/:id/downloadTải xuống kết quả công việc (miễn phí)
POST/api/v1/convert/officeChuyển đổi tài liệu Office/ODF (quyền pdf.convert)
POST/api/v1/convert/linearizeTuyến tính hóa một PDF để xem web nhanh (quyền pdf.convert)
POST/api/v1/convert/typstBiên dịch mã nguồn Typst/Markdown thành PDF (quyền pdf.convert)
POST/api/v1/ocrOCR một PDF được quét thành PDF có thể tìm kiếm (quyền pdf.ocr)
POST/api/v1/ocr/textOCR một hình ảnh đơn lẻ thành văn bản (quyền pdf.ocr)
POST/api/v1/validate/pdfaKiểm tra tuân thủ PDF/A (quyền pdf.validate)
POST/api/v1/validate/pdfuaKiểm tra khả năng truy cập PDF/UA (quyền pdf.validate)
POST/api/v1/validate/signatureBáo cáo xác minh chữ ký số (quyền pdf.validate)
POST/api/v1/signChữ ký số PAdES (quyền pdf.sign; tùy chọn cặp khóa PEM)
POST/api/v1/redactBiên tập thực sự các kết quả khớp hoặc vùng văn bản (quyền pdf.redact)
POST/api/v1/extractTrích xuất trường dựa trên văn bản và quy tắc (quyền pdf.extract)
POST/api/v1/doclingPhân tích bố cục có cấu trúc qua Docling (quyền pdf.extract)
POST/api/v1/scan/piiQuét văn bản để tìm thông tin cá nhân (quyền 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