开发者文档
在线调试 ↗图片识别 API
上传一张图片,以 JSON 获取识别文字。
POST
/ocr当前接口无需 API Key 或 Authorization。支持 JPG、PNG、WebP,单张不超过 10 MB、2000 万像素。使用文件表单上传,不接受图片网址或 Base64 JSON。
快速调用
将示例中的图片路径替换为本地文件路径。请保留 mode=general,用于单图文字识别。
cURL
Python
上传时让 cURL 或 requests 自动生成 multipart 的 Content-Type 和 boundary,无需手动设置。示例预留 150 秒请求等待时间,首次识别可能稍慢。
请求参数
请求方式:POST /ocr;编码:multipart/form-data。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
file | 文件 | 是 | 单张有效的 JPG、PNG 或 WebP 图片。 |
mode | 字符串 | 否 | general:文字识别,推荐显式填写。professional:附加现有证件规则检查;接口默认值为 professional。 |
document_type | 字符串 | 否 | 默认空字符串,通常可省略。专业模式在未自动匹配材料时可用此值指定材料类型。 |
材料类型可填写:身份证正面、身份证反面、行驶证正页、行驶证副页、登记证主页、登记证3-4页。专业模式目前使用预填示例字段做规则比对,返回可能含 demo、professional_status 与 professional_audit,不代表真实案件的完整审核。本文调用示例均使用通用识别。
返回结果
成功返回 HTTP 200 和 JSON。下方是测试图片“API TEST 2026”的实测响应节选;识别标识、耗时和内容随请求变化,实际响应还包含其他字段。
成功响应示例
{
"text": "API TEST 2026",
"raw_text": "API TEST 2026",
"mode": "general",
"engine": "paddle",
"model": "PP-OCRv5_mobile",
"confidence": 0.9596,
"elapsed_ms": 181,
"recognition_id": "99c696c1-d66e-41a1-928a-73a47b0fe76c",
"document_type": ""
}
| 字段 | 说明 |
|---|---|
text | 识别正文。没有可辨认文字时可能为空字符串。 |
raw_text | 识别原文,可能包含需要进一步核对的低可信片段。 |
recognition_id | 本次识别的标识,不是异步任务查询入口。 |
elapsed_ms | 底层文字识别处理耗时,单位毫秒,不是整个专业检查的总耗时。 |
engine / model | 实际使用的识别引擎和模型名称。 |
confidence | 识别置信度;引擎未提供时可能为 null。 |
document_type | 识别出的材料类型,未匹配到时为空字符串。 |
错误说明
先检查 HTTP 状态码。错误提示可能位于 detail 或 message;detail 也可能是参数错误列表。
| 状态码 | 含义与处理方式 |
|---|---|
| 400 | 缺少文件、空文件或请求格式有误。缺少 file 时,现有服务可能返回通用 JSON 格式提示,请同时查看 detail 中的缺失字段。 |
| 413 | 文件超过 10 MB,或图片像素过大。请缩小图片后重试。 |
| 415 | 图片格式不支持、内容损坏,或文件并非有效图片。 |
| 422 | mode 等参数值不合法。 |
| 429 | 识别服务暂时繁忙,请稍后重试。 |
| 502 / 503 | 识别依赖不可用或返回异常,请稍后重试。 |
| 504 | 等待识别超时,请稍后重试。 |
错误响应示例 · HTTP 415
{"detail": "文件不是有效图片或图片已损坏"}
车辆贷款资料审核
上传材料,核对信息,查看审核报告。
选择材料,上传并确认识别结果
识别方式
原始图片
或拖放、粘贴图片到这里
JPG / PNG / WebP · 最大 10 MB识别结果
等待上传图片
识别后可与左侧原图对照。识别结果将在这里呈现