Response structure
documentParsing returns a JSON response directly — no secondary download via downloadUrl is needed.
Top-level shape
The API directly returns the parse result JSON:
json
{
"code": 200,
"message": "Success",
"x_request_id": "6512815b16964dc3a04939ebf685d975",
"file_type": "PDF",
"result": {
"pages": [ ... ],
"detail": [ ... ],
"catalog": {},
"markdown": "# Sample PDF ...",
"valid_page_number": 1,
"total_page_number": 1,
"success_count": 1,
"excel_base64": ""
},
"metrics": [ ... ],
"image_process": []
}Key fields
| Field | Meaning |
|---|---|
code | Business status code. 200 for success; 06001 for insufficient assets (page quota exhausted) |
message | Human-readable response message |
x_request_id | Request trace ID for troubleshooting |
file_type | Detected input type, for example PDF |
result | Main parse result, including page output and summary counters |
metrics | Per-page processing metrics for quality and performance analysis |
image_process | Extra image-processing output; usually empty for standard parse scenarios |
The result object
result is the main payload. Common fields include:
| Field | Meaning |
|---|---|
result.pages | Array of per-page parse results, with structured (blocks) and content (lightweight text) |
result.detail | Flat paragraph-level view merging all page blocks into one ordered array |
result.markdown | Merged Markdown output |
result.catalog | Document tree / table of contents |
result.valid_page_number | Number of successfully parsed pages |
result.total_page_number | Total pages in the input file |
result.success_count | Count of successful pages or result units |
result.excel_base64 | Base64-encoded Excel output when export format includes Excel |
Asset insufficient error
When your page quota is exhausted, the API returns:
json
{
"code": "06001",
"msg": "You have run out of the files which could be processed",
"data": null
}How it is usually consumed
- For a full-text reading view, start with
result.markdown - For per-page rendering, inspect
result.pages - For flat paragraph-level processing, inspect
result.detail - For navigation or hierarchy, inspect
result.catalog - For quality or performance monitoring, inspect
metrics
Reading with other pages
- For the structure inside each page, go to Page details
- For request-side tuning, go to Parse options
- For metric interpretation, go to Metrics