Key Extraction · API v3

คู่มือ REST API

Base URL คือ https://backend.aksonocr.comทุกเส้นทางอยู่ภายใต้ /api/v3/key-extract

Method	Path	รายละเอียด
POST	`/files`	อัปโหลดไฟล์ · 201 Created
DELETE	`/files/:fileId`	ลบไฟล์ที่ไม่มี job ยึดอยู่
POST	`/jobs`	สร้างงาน · 202 · ต้องมี Idempotency-Key
GET	`/jobs/:jobId`	สถานะและความคืบหน้า (ไม่มีผลเต็ม)
GET	`/jobs/:jobId/result`	ผลเมื่อเสร็จ
GET	`/jobs`	รายการงานแบบ cursor
POST	`/jobs/:jobId/cancel`	ยกเลิกแบบ best-effort
DELETE	`/jobs/:jobId`	ลบต้นทางและผลที่เก็บไว้
POST	`/schemas/validate`	ตรวจ JSON Schema
POST	`/templates`	สร้างเทมเพลตเวอร์ชัน 1
GET	`/capabilities`	ลิมิตและฟีเจอร์ที่เปิดอยู่

1. อัปโหลด

POSThttps://backend.aksonocr.com/api/v3/key-extract/files

bash

curl --request POST \
  --url https://backend.aksonocr.com/api/v3/key-extract/files \
  --header 'X-API-Key: <YOUR_API_KEY>' \
  --form '[email protected]'

2. สร้างงาน

POSThttps://backend.aksonocr.com/api/v3/key-extract/jobs

bash

curl --request POST \
  --url https://backend.aksonocr.com/api/v3/key-extract/jobs \
  --header 'X-API-Key: <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: invoice-2026-001' \
  --data '{
    "inputs": [{ "file_id": "file_01J9..." }],
    "data_schema": {
      "type": "object",
      "properties": {
        "invoice_no": { "type": "string" }
      }
    },
    "output": { "evidence": "bbox" }
  }'

3. Poll แล้วดึงผล

GEThttps://backend.aksonocr.com/api/v3/key-extract/jobs/{jobId}

หยุดเมื่อสถานะเป็น completed, failed, cancelled หรือ expired แล้วเรียก /result แนะนำช่วง 2 วินาที และใช้ exponential backoff ถ้าได้ 429

4. Cancel / Delete

ยกเลิกได้ขณะ queued หรือ processing การลบงานจะลบทั้งไฟล์ที่ถูก lease และผลที่เก็บไว้

รหัสตอบกลับ

HTTP	ความหมาย
201	อัปโหลดไฟล์สำเร็จ
202	รับงานเข้าคิวแล้ว
200	อ่านสถานะ / ผล / ยกเลิก / ลบสำเร็จ
400	ฟิลด์หรือไฟล์ไม่ถูกต้อง
401	ไม่มีหรือ API key ไม่ถูกต้อง
409	result_not_ready หรือ file_in_use
410	ผลหมดอายุ
422	schema ไม่ผ่าน subset ที่รองรับ
429	เกินลิมิต

สเปกฟิลด์แบบตารางอยู่ที่ API Reference · Key Extraction

สูตรสำเร็จ

คู่มือย้ายเวอร์ชัน: v1 ไป v3