You need to enable JavaScript to run this app.
导航
接口文档
最近更新时间:2022.06.13 14:24:50首次发布时间:2022.02.25 11:08:59
我的收藏
有用
有用
无用
无用

接入指引

请先查看接入指引了解具体接入方式,再参考此文档完成接入。

请求API

名称内容
请求方式POST
Content-Typeapplication/x-www-form-urlencoded
图片要求1. 文件格式:pdf/doc/docx。
2. 图片文件大小:最大 10 MB。

输入参数

Query参数:

参数可选/必选类型说明
Action必选String接口名,取值:OCRPdf
Version必选String版本号,取值:2021-08-23

Body参数:

参数可选/必选类型说明
image_base64必选String文件base64编码
file_type可选String文件类型:"pdf"/"doc", 默认为"pdf"

API返回 (通用返回字段见通用返回字段及错误码

data 字段说明

字段类型说明备注
page_infosArray of page_info页面信息字段说明见下方

page_info 字段说明

字段类型说明备注
polyArray of Points行矩形框信息(可能有倾斜矩形)四个点的坐标,[左上, 右上, 右下, 左下]
textArray of String识别结果文本识别结果

Point信息

字段类型说明备注
xfloat坐标点横坐标占尺寸的百分比
yfloat坐标点纵坐标占尺寸的百分比

错误码

HttpCode错误码错误消息描述
20010000请求成功
40150205"Image Size Exceeds Maximum Limit: please compress the image"文件大小超过上限
40050207"Image Decode Error: image format unsupported"文件解码错误,文件内容为空或格式错误
40150400"Access denied due to invalid authentication information"鉴权失败
40450402"Invalid Request URL"无效的请求路径
50050500"Internal Error: please contact with bytedance engineering team"内部错误,需要联系开发人员

注: 更多通用反馈字段通用返回值和状态码

返回值示例

主页面图片返回值示例

{
    "code":10000,
    "data":{
        "page_infos":[
            {
                "poly": [
                    [0.408198, 0.105675],
                    [0.589619, 0.105675],
                    [0.589619, 0.127048],
                    [0.408198, 0.127048]
                ]
                "text": [
                    "咨询服务合同"
                ]
            }
        ]
    },
    "message":"Success",
    "request_id":"021629427766315fdbddc01010500400000000000000068da22fd",
    "time_elapsed":"5.330714543s"
}