API overview
Updated at:
Overview of the ParseX API.
With the ParseX API, you can perform document parsing & field extraction programmatically. All endpoints are served through the DashScope gateway.
Service address
https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x
All endpoints share the same service address, with the path prefix /api/v2/apps/parse-x.
Protocol conventions
- All endpoints are accessed over HTTPS; HTTP is not supported.
- Request and response bodies are in JSON format with the UTF-8 charset.
- All endpoints use the
POSTmethod.
Authentication and request headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer $DASHSCOPE_API_KEY; see Authentication for how to obtain it |
Content-Type | Yes | application/json |
Common response format
All endpoints return a unified JSON structure.
Success response:
{
"request_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"data": {
"biz_id": "parseX-video-20260911-c954ec4fc32e4bc3a8cfda61841e4f19"
}
}
Error response:
{
"code": "InvalidParameter",
"message": "The biz_id must be provided.",
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Async calling flow
After the official entry point is released, the submit endpoint returns a biz_id. The caller uses this ID to call the corresponding result endpoint until data.status is success or failed.
graph LR
A[Submit task] --> B[Get biz_id]
B --> C[Call result endpoint]
C --> D{data.status}
D -->|processing| C
D -->|success| E[Read result]
D -->|failed| F[Handle based on error info]
- Submit a parsing task: Submit a document or audio/video parsing task; returns a biz_id for async queries.
- Submit an extraction task: Submit a structured field extraction task based on a JSON Schema.
- Error codes: View the error response format and public error codes.
Is this page helpful?