帮助与文档 > 产品文档 > 视觉智能服务 > API文档 > 文档转Markdown
文档转Markdown

文件转 Markdown API 文档

1. 提交转换任务

接口路径: POST https://openapi.youdao.com/proxy/http/file2md-upload

Content-Type: multipart/form-data

请求参数

参数 类型 必填 说明
appKey String 智云平台应用 Key
salt String 签名随机盐
sign String 签名(SHA-256,详见签名规则)
curtime String 当前时间戳(秒)
file File 待转换的文件(二进制,暂时仅支持 PDF 格式), 文件名需要规范.pdf后缀

注意: 暂时仅支持 PDF 文件,文件名后缀必须为 .pdf,后续提供更多文件类型支持

签名规则(v4)

sign = SHA256(appKey + salt + curtime + appSecret)

返回示例

成功(HTTP 200)

{
  "code": "0",
  "message": "成功",
  "data": {
    "taskId": "a1b2c3d4e5f6..."
  },
  "requestId": "xxx"
}

失败

{
  "code": "907001",
  "message": "文件转换服务调用失败,请稍后重试",
  "data": null,
  "requestId": "xxx"
}

错误码

code 说明
0 成功
101 参数错误
202 签名错误
907001 文件转换服务调用失败
907004 文件页数获取失败
907005 存储异常,请联系管理员

2. 查询转换结果

接口路径: POST https://openapi.youdao.com/proxy/http/file2md-query

Content-Type: application/x-www-form-urlencoded

请求参数

参数 类型 必填 说明
appKey String 智云平台应用 Key
salt String 签名随机盐
sign String 签名(SHA-256,详见签名规则)
curtime String 当前时间戳(秒)
taskId String 任务 ID(由上传接口返回)

签名规则(v4)

sign = SHA256(appKey + salt + curtime + appSecret)

返回示例

处理中

{
  "code": "0",
  "message": "成功",
  "data": {
    "status": "PROCESSING"
  },
  "requestId": "xxx"
}

转换成功

{
  "code": "0",
  "message": "成功",
  "data": {
    "status": "SUCCESS",
    "mdResult": "# 标题\n\n正文内容..."
  },
  "requestId": "xxx"
}

转换失败

{
  "code": "0",
  "message": "成功",
  "data": {
    "status": "FAILED"
  },
  "requestId": "xxx"
}

错误码

code 说明
0 成功(status 字段表示转换状态)
101 参数错误
202 签名错误
907002 任务不存在(taskId 错误)
907003 无权查询该任务(appKey 不匹配)

3. 调用流程

1. 调用 /http/file2md-upload 上传文件,获取 taskId
2. 轮询 /http/file2md-query 查询结果
   - status=PROCESSING:继续等待,建议间隔 3~10 秒
   - status=SUCCESS:mdResult 即为 Markdown 内容
   - status=FAILED:转换失败,可重新提交

4. 调用示例

java demo