API 文件

透過我們的 API 將 FreeOCR.AI 整合到您的應用程式中。

身份驗證

所有 API 請求都需要在 Authorization 標頭中以 Bearer Token 形式傳遞 API 金鑰。

Authorization: Bearer focr_your_api_key_id

在API 金鑰頁面建立和管理您的 API 金鑰。

速率限制

預設速率限制：每個 API 金鑰每分鐘 200 個請求。

速率限制可按金鑰調整。如需自訂限制，請聯絡支援團隊。

POST /ocr

線上演示

從圖像中提取文字，保留版面佈局。

參數

multipartimage(必填) - 圖像檔案

queryformat(可選) - 回應格式: json（預設）、text、docx

queryversion(可選) - 模型版本: 260428（預設）

回應

jsonContent-Type: application/json

{
  "text": "# Document Title\n\nExtracted markdown content..."
}

回傳 GitHub Flavored Markdown，保留版面佈局，包括 HTML 表格和 LaTeX 公式。

textContent-Type: application/json

{
  "text": "Document Title\n\nExtracted plain text content..."
}

Markdown 透過內部轉換剝離為純文字。

docxContent-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document

二進位檔案下載。 Content-Disposition: attachment; filename="result.docx"

範例

Format:

curl -X POST "https://freeocr.ai/api/v1/platform/ocr" \
  -H "Authorization: Bearer focr_your_key" \
  -F "image=@document.png"

POST /table

線上演示

從圖像中提取表格為結構化資料。

參數

multipartimage(必填) - 圖像檔案

queryformat(可選) - 回應格式: json（預設）、csv、xlsx

queryversion(可選) - 模型版本: 260428（預設）

回應

jsonContent-Type: application/json

{
  "tables": [
    {
      "title": "Sales Report",
      "html": "<table><tr><th>Item</th><th>Qty</th></tr><tr><td>Apple</td><td>10</td></tr></table>"
    }
  ]
}

每個表格包含 title 和 HTML 表格字串形式的內容。

csvContent-Type: text/csv; charset=utf-8

純文字 CSV 檔案下載。多個表格透過 --- SheetName --- 分隔符分隔。 Content-Disposition: attachment; filename="tables.csv"

xlsxContent-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

二進位 XLSX 檔案下載。每個表格成為以其標題命名的獨立工作表。 Content-Disposition: attachment; filename="tables.xlsx"

範例

Format:

curl -X POST "https://freeocr.ai/api/v1/platform/table" \
  -H "Authorization: Bearer focr_your_key" \
  -F "image=@spreadsheet.png"

POST /extract

線上演示

使用 AI 從圖像中提取特定欄位。

參數

multipartimage(必填) - 圖像檔案

queryfields(必填) - 要提取的欄位（重複參數或 JSON 陣列）

queryformat(可選) - 回應格式: json（預設）、csv、xlsx

queryversion(可選) - 模型版本: 260428（預設）、260215

回應

jsonContent-Type: application/json

{
  "result": [
    { "key": "name", "values": ["John Doe"] },
    { "key": "date", "values": ["2024-03-15"] },
    { "key": "amount", "values": ["$1,234.56"] }
  ]
}

每個請求的欄位以 key 和提取的 values 陣列形式回傳。

csvContent-Type: text/csv; charset=utf-8

CSV 檔案，欄位鍵作為欄標題，提取的值作為列。 Content-Disposition: attachment; filename="extraction.csv"

xlsxContent-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

XLSX 檔案，包含單個 "Results" 工作表，佈局與 CSV 相同。 Content-Disposition: attachment; filename="extraction.xlsx"

範例

Format:

curl -X POST "https://freeocr.ai/api/v1/platform/extract?fields=name&fields=date&fields=amount" \
  -H "Authorization: Bearer focr_your_key" \
  -F "image=@invoice.png"

錯誤回應

401

未授權

{ "error": { "code": "unauthorized", "message": "無效的 API 金鑰" } }

402

餘額不足

{ "error": { "code": "insufficient_credits", "message": "餘額不足，請充值。" } }

429

超出速率限制

{ "error": { "code": "rate_limit_exceeded", "message": "超出速率限制，請稍後重試。" } }

500

內部錯誤

{ "error": { "code": "internal_error", "message": "圖像處理失敗" } }