API Reference
OCR v3 — Async
สร้างงานแล้วได้ jobId ทันที ประมวลผลพื้นหลัง สูงสุด 1,000 หน้า / ไฟล์ 10 MBaction เป็น transcribe หรือ extractor
ต้องการ bounding box?
extractor ของ OCR v3 ไม่คืนตำแหน่งบนเอกสาร ใช้ Key Extraction v3
| Method | Path | รายละเอียด |
|---|---|---|
| POST | /api/v3/ocr | สร้างงานจาก JSON (URL หรือ base64) · 202 |
| POST | /api/v3/ocr/upload | สร้างงานจากไฟล์ multipart · 202 |
| GET | /api/v3/ocr/:jobId | สถานะ |
| GET | /api/v3/ocr/:jobId/result | ผลเมื่อเสร็จ |
| POST | /api/v3/ocr/:jobId/cancel | ยกเลิก |
| DELETE | /api/v3/ocr/:jobId | ลบงาน |
สร้างงาน
POST
https://backend.aksonocr.com/api/v3/ocrjson
{"action": "transcribe","model": "AksonOCR-preview","document": {"type": "document_url","document_url": "https://example.com/report.pdf"},"webhookUrl": "https://example.com/hooks/ocr"}
| ฟิลด์ | จำเป็น | รายละเอียด |
|---|---|---|
document | ใช่ | type: image_url | document_url | base64 |
model | ใช่ | AksonOCR-preview | handwriting | 1.0 |
action | ไม่ | transcribe (ค่าเริ่มต้น) หรือ extractor |
mode | ไม่ | normal เท่านั้นในตอนนี้ |
webhookUrl | ไม่ | HTTPS เมื่องานเข้าสู่สถานะปลายทาง |
customFields | extractor | อาร์เรย์ { key, description, example } |
templateId | extractor | เทมเพลตจาก Dashboard |
Response 202
json
{"jobId": "ocr_01J...","status": "queued"}
Poll และดึงผล
GET
https://backend.aksonocr.com/api/v3/ocr/{jobId}หยุดเมื่อสถานะเป็น completed, failed หรือ cancelled แล้วเรียก /result
bash
curl -sS 'https://backend.aksonocr.com/api/v3/ocr/$JOB_ID' \-H 'X-API-Key: <YOUR_API_KEY>'curl -sS 'https://backend.aksonocr.com/api/v3/ocr/$JOB_ID/result' \-H 'X-API-Key: <YOUR_API_KEY>'
action: extractor
คืน pages[].structuredData ตาม customFields หรือ templateId ไม่มี bbox — ดู Key Extraction v3 ถ้าต้องการกรอบบนหน้า
json
{"action": "extractor","model": "AksonOCR-preview","document": { "type": "image_url", "image_url": "https://example.com/invoice.jpg" },"customFields": [{ "key": "เลขที่ใบแจ้งหนี้", "description": "Invoice number" },{ "key": "ยอดรวม", "description": "Grand total including VAT" }]}
อายุงาน
- เก็บผล 72 ชั่วโมงหลังสร้าง
- งานหมดอายุถูกลบทุกชั่วโมง
- signed URL ของผลมีอายุ 1 ชั่วโมง และต่อเมื่อเรียก status/result
HTTP
| HTTP | ความหมาย |
|---|---|
| 202 | รับงานเข้าคิว |
| 200 | อ่านสถานะ / ผล / ยกเลิก |
| 402 | เครดิตไม่พอ |
| 404 | ไม่พบงาน |
| 429 | เกินลิมิต |