API Reference
Key Extraction v3
Base path https://backend.aksonocr.com/api/v3/key-extractทุก request ต้องมี X-API-Key
สัญญาอะซิงค์: อัปโหลดไฟล์ → สร้างงาน → poll สถานะ → ดึงผล ค่าอยู่ใน data หลักฐานและ bounding box อยู่ใน field_metadata
Resources
Files
อัปโหลดและลบไฟล์ต้นทาง ได้ file_id
Jobs
สร้าง poll ยกเลิก ลบงาน — ต้องมี Idempotency-Key
Result
data, field_metadata, bbox xyxy 0–1
Schemas
ตรวจ JSON Schema ก่อนสร้างงาน (ไม่คิด OCR)
Templates
เทมเพลตเวอร์ชัน immutable สำหรับเอกสารซ้ำ
Capabilities
ลิมิต ฟีเจอร์ และค่าเริ่มต้นของโปรเจกต์
สัญญาที่ใช้ร่วมกัน
| หัวข้อ | กติกา |
|---|---|
| Auth | Header X-API-Key เท่านั้น |
| Idempotency | POST /jobs ต้องมี Idempotency-Key |
| Content-Type | อัปโหลดเป็น multipart/form-data ที่เหลือเป็น application/json |
| IDs | opaque string — ห้าม parse โครงสร้างภายใน |
| Pagination | cursor + limit (1–100, ค่าเริ่มต้น 20) |
| Errors | application/problem+json — แยก logic จาก code ไม่ใช่ title |
| BBox | ค่าเริ่มต้น output.evidence=bbox · [x_min, y_min, x_max, y_max] ช่วง 0–1 |
คู่มือแนวคิด
workflow และตัวอย่าง overlay อยู่แท็บ คู่มือ · Key Extraction