PDFLean
Rujukan API

API Aliran Kerja

Semua titik akhir memerlukan sesi log masuk (kuki) kecuali dinyatakan sebaliknya. Respons adalah JSON: { ok: true, data } atau { ok: false, error }. Ralat biasa: 400 pengesahan, 401 tidak disahkan, 403 dilarang, 404 tidak dijumpai, 429 had kadar dilebihi, 502/503 huluan. Titik akhir awam /api/v1 disahkan dengan Authorization: Bearer pdflean_… dan mesti menghantar jenis kandungan JSON.

Di halaman ini

Aliran Kerja

KaedahLaluanPenerangan
GET/api/workflowsSenaraikan aliran kerja anda
POST/api/workflowsCipta aliran kerja (draf)
GET/api/workflows/:idDapatkan aliran kerja
PUT/api/workflows/:idKemas kini aliran kerja (draf, versi+1)
DELETE/api/workflows/:idPadam aliran kerja
POST/api/workflows/:id/publishTerbitkan satu versi
GET/api/workflows/:id/versionsSenaraikan versi
POST/api/workflows/:id/versions/:version/restorePulihkan versi

Pencetus & Hook

KaedahLaluanPenerangan
GET/api/workflows/triggersSenaraikan pencetus
POST/api/workflows/triggersCipta pencetus (webhook/jadual/e-mel/pemacu)
POST/api/workflows/triggers/:id/runJalankan pencetus sekarang
DELETE/api/workflows/triggers/:idPadam pencetus
POST/api/workflows/hook/:tokenWebhook masuk (pengesahan token, tiada sesi; badan JSON)

Larian & Semakan

KaedahLaluanPenerangan
POST/api/workflows/runsCipta larian (dalam giliran)
GET/api/workflows/runsSenaraikan larian
GET/api/workflows/runs/:idButiran dan langkah larian
POST/api/workflows/runs/:id/retryCuba lagi larian yang gagal/dalam giliran
GET/api/workflows/reviewsSemakan manusia yang belum selesai
POST/api/workflows/reviews/:idLuluskan/tolak semakan

Jambatan Awan

KaedahLaluanPenerangan
GET/api/workflows/cloud/statusStatus jambatan VPS kendiri
POST/api/workflows/cloud/convertOffice → PDF melalui VPS kendiri (LibreOffice)
POST/api/workflows/cloud/ocrOCR melalui VPS kendiri (Tesseract)
POST/api/workflows/cloud/extractEkstrak medan invois/generik daripada PDF (pdfjs + peraturan)

Arkib & Retensi

KaedahLaluanPenerangan
GET/api/workflows/archiveSenaraikan dokumen diarkibkan dan integriti rantaian
POST/api/workflows/archiveArkibkan dokumen (base64, rantaian cincangan SHA-256)
GET/api/workflows/archive/:id/verifySahkan rantaian cincangan arkib
GET/api/workflows/archive/exportEksport CSV audit arkib (termasuk rekod pemadaman)
POST/api/workflows/archive/:id/holdTetapkan/kosongkan penahanan undang-undang
POST/api/workflows/archive/:id/complianceDayakan kunci pematuhan WORM yang tidak boleh dipulihkan
DELETE/api/workflows/archive/:idPadam arkib (disekat di bawah penahanan undang-undang)

API Awam v1

KaedahLaluanPenerangan
GET/api/v1/openapi.jsonSpesifikasi OpenAPI 3.1 (awam, tanpa pengesahan)
GET/api/v1/mePemilik kunci API semasa (kunci Bearer)
GET/api/v1/usagePapan pemuka penggunaan: baki, sejarah 30 hari, panggilan terkini
GET/api/v1/workflowsSenaraikan aliran kerja (skop workflow.read)
GET/api/v1/workflows/:idDapatkan aliran kerja (skop workflow.read)
POST/api/v1/workflows/:id/runBeraturkan satu jalankan (skop workflow.run)
GET/api/v1/runsSenaraikan jalankan (skop workflow.read)
POST/api/v1/pdf/mergeGabungkan PDF (skop pdf.merge; 2–10 fail base64)
POST/api/v1/pdf/splitKekalkan halaman yang dipilih (skop pdf.split; julat seperti "1-3,5")
POST/api/v1/pdf/compressMampatkan PDF secara struktur (skop pdf.compress)
GET/api/v1/jobs/:idStatus kerja (percuma)
GET/api/v1/jobs/:id/downloadMuat turun hasil kerja (percuma)
POST/api/v1/convert/officeTukar dokumen Office/ODF (skop pdf.convert)
POST/api/v1/convert/linearizeLinearkan PDF untuk paparan web yang laju (skop pdf.convert)
POST/api/v1/convert/typstSusun sumber Typst/Markdown kepada PDF (skop pdf.convert)
POST/api/v1/ocrOCR PDF yang diimbas kepada PDF yang boleh dicari (skop pdf.ocr)
POST/api/v1/ocr/textOCR satu imej kepada teks (skop pdf.ocr)
POST/api/v1/validate/pdfaPemeriksaan pematuhan PDF/A (skop pdf.validate)
POST/api/v1/validate/pdfuaPemeriksaan kebolehcapaian PDF/UA (skop pdf.validate)
POST/api/v1/validate/signatureLaporan pengesahan tandatangan digital (skop pdf.validate)
POST/api/v1/signTandatangan digital PAdES (skop pdf.sign; pasangan kunci PEM pilihan)
POST/api/v1/redactPengredakan sebenar padanan teks atau kawasan (skop pdf.redact)
POST/api/v1/extractPengekstrakan medan berasaskan teks dan peraturan (skop pdf.extract)
POST/api/v1/doclingPenguraian layout berstruktur melalui Docling (skop pdf.extract)
POST/api/v1/scan/piiImbas teks untuk maklumat peribadi (skop 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