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": "图像处理失败" } }