GoodOCR API

OCR 辨識 API 文件 — 透過 API 整合 OCR + AI 結構化辨識

Authentication

所有 API 請求需要在 Header 帶上 X-API-Key

Your API Key: YOUR_API_KEY
Base URL: https://goodocr-sit.goodarc.com/api/v1

Endpoints

POST /v1/ocr
上傳圖片或 PDF 進行 OCR 辨識,回傳結構化 JSON
參數類型說明
file 必填File圖片(JPG/PNG)或 PDF 檔案
type 必填String辨識樣態 key(由 /v1/modes 取得)
GET /v1/quota
查詢剩餘額度與到期日
GET /v1/modes
列出可用的辨識樣態

Request Example

OCR 辨識

cURL
Python
NodeJS
PHP
Java
C#
Ruby
curl --request POST \
  --url 'https://goodocr-sit.goodarc.com/api/v1/ocr' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --form 'file=@invoice.jpg' \
  --form 'type=invoice'

Response Example

{
  "results": [
    {
      "filename": "invoice.jpg",
      "status": "success",
      "data": {
        "買方名稱": "ABC有限公司",
        "賣方名稱": "全家便利商店",
        "發票號碼": "AB12345678",
        "金額總計": "150",
        ...
      },
      "processing_ms": 3200
    }
  ],
  "pages_used": 1,
  "quota": {
    "remaining": 9998,
    "used_pages": 2
  }
}

Error Codes

HTTP Status說明
401API Key 無效或缺少
403額度不足或帳戶已過期
400缺少必要參數或樣態不存在