Upload
Upload Endpoint ให้คุณส่งไฟล์เอกสารเดี่ยวเพื่อประมวลผล OCR ไฟล์จะถูกเก็บและเข้าคิวสำหรับการดึงข้อมูลด้วย AI พร้อมสร้าง Processing History Record โดยอัตโนมัติ คุณสามารถติดตามความคืบหน้าได้ผ่าน Endpoint Processing History
อัปโหลดไฟล์
POST /v1/openapi/uploadอัปโหลดไฟล์เดียวเพื่อประมวลผล OCR และดึงข้อมูลด้วย AI
Headers:
| Header | Value | Required |
|---|---|---|
X-API-Key | ocr_your_api_key | Yes |
Content-Type | multipart/form-data | Yes |
Request Body (multipart/form-data):
| Field | Type | Required | Description |
|---|---|---|---|
file | File | Yes | เอกสารที่ต้องการอัปโหลด (PDF หรือรูปภาพ) |
fileName | string | Yes | ชื่อไฟล์ต้นฉบับ (เช่น invoice-2026.pdf) |
fileType | string | Yes | ประเภทไฟล์: pdf, image, หรือ document |
fileSize | string | Yes | ขนาดไฟล์หน่วย Byte เป็น String (เช่น "204800") |
mimeType | string | Yes | MIME Type ของไฟล์ (เช่น application/pdf) |
projectId | string | Yes | ID ของ Project เป้าหมาย |
templateId | string | No | ID ของ Template ที่ต้องการใช้ดึงข้อมูล |
uploadType | string | No | ตัวระบุประเภทการอัปโหลด (Optional) |
metadata | string | No | Metadata เพิ่มเติมในรูปแบบ JSON String |
batchId | string | No | เชื่อมการอัปโหลดนี้กับ Batch ที่มีอยู่ |
หมายเหตุ:
- สำหรับ Project Token ค่า
projectIdต้องตรงกับ Project ของ Token ยังคงต้องส่ง Field นี้ - สำหรับ Organization Token ค่า
projectIdต้องอยู่ใน Organization ของ Token
Example Request:
curl -X POST "https://api.ocriva.com/v1/openapi/upload" \
-H "X-API-Key: ocr_your_api_key" \
-F "file=@/path/to/invoice-2026.pdf" \
-F "fileName=invoice-2026.pdf" \
-F "fileType=pdf" \
-F "fileSize=204800" \
-F "mimeType=application/pdf" \
-F "projectId=68db4aa2967d9c03fa9b5e74" \
-F "templateId=68db4bb3a67e9c04fb0c6f85"Example Response (201 Created):
{
"id": "68dc1cc4b78f0d15ec2a7f91",
"fileName": "invoice-2026.pdf",
"fileUrl": "https://storage.ocriva.com/org-abc/invoice-2026.pdf",
"publicUrl": "https://storage.ocriva.com/public/org-abc/invoice-2026.pdf",
"filePath": "org-abc/projects/proj-xyz/invoice-2026.pdf",
"fileSize": "204800",
"mimeType": "application/pdf",
"status": "uploaded",
"templateId": "68db4bb3a67e9c04fb0c6f85",
"projectId": "68db4aa2967d9c03fa9b5e74",
"uploadedAt": "2026-03-31T10:00:00.000Z",
"userId": "68da3991c56e8b02ea1b4d60",
"organizationId": "68da2880b45d7a01d90a3c51"
}Common Errors:
| Status | Cause |
|---|---|
400 | ไม่มีไฟล์แนบ หรือ Form Field ที่จำเป็นหายไป |
401 | Token ไม่ถูกต้อง หรือ projectId ไม่ตรงกับ Scope ของ Token |
404 | ไม่พบ Project ที่ระบุ |