PDFLean
Referensi API

API Alur Kerja

Semua titik akhir memerlukan sesi yang sudah masuk (cookie) kecuali dinyatakan lain. Respons berupa JSON: { ok: true, data } atau { ok: false, error }. Kesalahan umum: 400 validasi, 401 tidak terautentikasi, 403 terlarang, 404 tidak ditemukan, 429 dibatasi laju, 502/503 upstream. Titik akhir publik /api/v1 mengautentikasi dengan Authorization: Bearer pdflean_… dan harus mengirimkan tipe konten JSON.

Di halaman ini

Alur Kerja

MetodeJalurDeskripsi
GET/api/workflowsDaftar alur kerja Anda
POST/api/workflowsBuat alur kerja (draf)
GET/api/workflows/:idAmbil alur kerja
PUT/api/workflows/:idPerbarui alur kerja (draf, versi+1)
DELETE/api/workflows/:idHapus alur kerja
POST/api/workflows/:id/publishTerbitkan versi
GET/api/workflows/:id/versionsDaftar versi
POST/api/workflows/:id/versions/:version/restorePulihkan versi

Pemicu & Hook

MetodeJalurDeskripsi
GET/api/workflows/triggersDaftar pemicu
POST/api/workflows/triggersBuat pemicu (webhook/jadwal/email/drive)
POST/api/workflows/triggers/:id/runJalankan pemicu sekarang
DELETE/api/workflows/triggers/:idHapus pemicu
POST/api/workflows/hook/:tokenWebhook masuk (auth token, tanpa sesi; body JSON)

Eksekusi & Tinjauan

MetodeJalurDeskripsi
POST/api/workflows/runsBuat eksekusi (antrean)
GET/api/workflows/runsDaftar eksekusi
GET/api/workflows/runs/:idDetail eksekusi dan langkah-langkahnya
POST/api/workflows/runs/:id/retryUlangi eksekusi yang gagal/antre
GET/api/workflows/reviewsTinjauan oleh manusia yang tertunda
POST/api/workflows/reviews/:idSetujui/tolak tinjauan

Jembatan Cloud

MetodeJalurDeskripsi
GET/api/workflows/cloud/statusStatus jembatan VPS mandiri
POST/api/workflows/cloud/convertOffice → PDF melalui VPS mandiri (LibreOffice)
POST/api/workflows/cloud/ocrOCR melalui VPS mandiri (Tesseract)
POST/api/workflows/cloud/extractEkstrak bidang faktur/generik dari PDF (pdfjs + aturan)

Arsip & Retensi

MetodeJalurDeskripsi
GET/api/workflows/archiveDaftar dokumen arsip dan integritas rantai
POST/api/workflows/archiveArsipkan dokumen (base64, rantai hash SHA-256)
GET/api/workflows/archive/:id/verifyVerifikasi rantai hash arsip
GET/api/workflows/archive/exportEkspor CSV audit arsip (termasuk penanda penghapusan)
POST/api/workflows/archive/:id/holdTetapkan/hapus legal hold
POST/api/workflows/archive/:id/complianceAktifkan kunci kepatuhan WORM yang tidak dapat dibatalkan
DELETE/api/workflows/archive/:idHapus arsip (diblokir selama legal hold)

API Publik v1

MetodeJalurDeskripsi
GET/api/v1/openapi.jsonSpesifikasi OpenAPI 3.1 (publik, tanpa autentikasi)
GET/api/v1/mePemilik kunci API saat ini (kunci Bearer)
GET/api/v1/usageDasbor penggunaan: saldo, riwayat 30 hari, panggilan terbaru
GET/api/v1/workflowsDaftar alur kerja (scope workflow.read)
GET/api/v1/workflows/:idMendapatkan alur kerja (scope workflow.read)
POST/api/v1/workflows/:id/runMengantrekan sebuah run (scope workflow.run)
GET/api/v1/runsDaftar run (scope workflow.read)
POST/api/v1/pdf/mergeMenggabungkan PDF (scope pdf.merge; 2–10 file base64)
POST/api/v1/pdf/splitMenyimpan halaman yang dipilih (scope pdf.split; rentang seperti "1-3,5")
POST/api/v1/pdf/compressKompresi struktural PDF (scope pdf.compress)
GET/api/v1/jobs/:idStatus pekerjaan (gratis)
GET/api/v1/jobs/:id/downloadMengunduh hasil pekerjaan (gratis)
POST/api/v1/convert/officeMengonversi dokumen Office/ODF (scope pdf.convert)
POST/api/v1/convert/linearizeMelinierkan PDF untuk tampilan web cepat (scope pdf.convert)
POST/api/v1/convert/typstMengompilasi sumber Typst/Markdown menjadi PDF (scope pdf.convert)
POST/api/v1/ocrOCR PDF hasil pindaian menjadi PDF yang dapat dicari (scope pdf.ocr)
POST/api/v1/ocr/textOCR satu gambar menjadi teks (scope pdf.ocr)
POST/api/v1/validate/pdfaPemeriksaan kepatuhan PDF/A (scope pdf.validate)
POST/api/v1/validate/pdfuaPemeriksaan aksesibilitas PDF/UA (scope pdf.validate)
POST/api/v1/validate/signatureLaporan verifikasi tanda tangan digital (scope pdf.validate)
POST/api/v1/signTanda tangan digital PAdES (scope pdf.sign; pasangan kunci PEM opsional)
POST/api/v1/redactRedaksi sesungguhnya dari kecocokan teks atau area (scope pdf.redact)
POST/api/v1/extractEkstraksi bidang berbasis teks dan aturan (scope pdf.extract)
POST/api/v1/doclingPenguraian tata letak terstruktur melalui Docling (scope pdf.extract)
POST/api/v1/scan/piiMemindai teks untuk informasi pribadi (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