API 概览 - 阿里云百炼

通过ParseX API，你可以以编程方式进行文档解析&信息抽取。所有接口通过 DashScope 网关提供服务。

服务地址

https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x

所有接口使用统一的服务地址，路径前缀为 /api/v2/apps/parse-x。

协议约定

所有接口均通过 HTTPS 访问，不支持 HTTP。
请求体和响应体均为 JSON 格式，字符集 UTF-8。
所有接口均使用 POST 方法。

认证与请求头

Header	必填	说明
`Authorization`	是	`Bearer $DASHSCOPE_API_KEY`，获取方式见鉴权
`Content-Type`	是	`application/json`

通用响应格式

所有接口返回统一的 JSON 结构。

成功响应：

{
  "request_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "data": {
    "biz_id": "parseX-video-20260911-c954ec4fc32e4bc3a8cfda61841e4f19"
  }
}

失败响应：

{
  "code": "InvalidParameter",
  "message": "The biz_id must be provided.",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

异步调用流程

正式入口发布后，提交接口返回 biz_id，调用方使用该 ID 调用对应的结果接口，直到 data.status 为 success 或 failed。

graph LR
  A[提交任务] --> B[获得 biz_id]
  B --> C[调用结果接口]
  C --> D{data.status}
  D -->|processing| C
  D -->|success| E[读取结果]
  D -->|failed| F[按错误信息处理]

提交解析任务：提交文档或音视频解析任务，返回 biz_id 用于异步查询。
提交抽取任务：按 JSON Schema 提交结构化信息抽取任务。
错误码：查看错误响应格式与公开错误码。

​服务地址

​协议约定

​认证与请求头

​通用响应格式

​成功响应：

​失败响应：