เอกสารอ้างอิง API
Workflow API
ทุกเอนด์พอยต์ต้องมีเซสชันที่ล็อกอินอยู่ (คุกกี้) เว้นแต่ระบุไว้เป็นอย่างอื่น การตอบกลับเป็น 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 | สร้างทริกเกอร์ (เว็บฮุก/ตามกำหนดเวลา/อีเมล/ไดรฟ์) |
| 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/convert | แปลง Office → PDF ผ่าน VPS แยกต่างหาก (LibreOffice) |
| POST | /api/workflows/cloud/ocr | OCR ผ่าน 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 ตรวจสอบย้อนหลังของคลังถาวร (รวมระเบียน tombstone) |
| POST | /api/workflows/archive/:id/hold | ตั้งค่า/ยกเลิก legal hold |
| POST | /api/workflows/archive/:id/compliance | เปิดใช้งานการล็อก WORM แบบปฏิบัติตามข้อกำหนดที่ย้อนกลับไม่ได้ |
| DELETE | /api/workflows/archive/:id | ลบรายการจัดเก็บถาวร (ถูกบล็อกระหว่างมี legal hold) |
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; ไฟล์ base64 2–10 ไฟล์) |
| 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 | ทำ OCR ไฟล์ PDF ที่สแกนเป็น PDF ที่ค้นหาได้ (ขอบเขต pdf.ocr) |
| POST | /api/v1/ocr/text | ทำ OCR ภาพเดียวเป็นข้อความ (ขอบเขต 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)
| Method | Endpoint | Credits |
|---|---|---|
| GET | /jobs/:id | 0 per call |
| GET | /jobs/:id/download | 0 per call |
| GET | /me | 0 per call |
| GET | /runs | 0 per call |
| GET | /usage | 0 per call |
| GET | /workflows | 0 per call |
| GET | /workflows/:id | 0 per call |
| POST | /ai/chat | 3 per call |
| POST | /ai/extract | 5 per call |
| POST | /ai/pii-detect | 4 per call |
| POST | /ai/summarize | 3 per call |
| POST | /ai/translate | 3 per call |
| POST | /convert/linearize | 1 per call |
| POST | /convert/office | 2 per call |
| POST | /convert/typst | 1 per call |
| POST | /docling | 3 per call |
| POST | /extract | 2 per call |
| POST | /ocr | 3 per page |
| POST | /ocr/text | 1 per call |
| POST | /pdf/compress | 1 per call |
| POST | /pdf/merge | 1 per call |
| POST | /pdf/split | 1 per call |
| POST | /redact | 3 per call |
| POST | /scan/pii | 2 per call |
| POST | /sign | 5 per envelope |
| POST | /validate/pdfa | 2 per call |
| POST | /validate/pdfua | 2 per call |
| POST | /validate/signature | 2 per call |
| POST | /workflows/:id/run | 1 per call |
| ai.chat | 2 per call | |
| convert.html_to_pdf | 4 per page | |
| convert.office_to_pdf | 10 per page | |
| convert.pdf_to_office | 12 per page | |
| convert.pdfa | 8 per page | |
| esign.envelope | 750 per envelope | |
| pdf.ocr | 3 per page | |
| pdf.ocr.high | 8 per page |