Skip to main content

提交解析任务

提交文档或音视频解析任务，返回 biz_id 用于异步查询

POST
/parse/submit
cURL
curl --request POST \ --url 'https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x/parse/submit' \ --header 'Authorization: Bearer <YOUR_API_KEY>' \ --header 'Content-Type: application/json' \ --data ' { "file_url": "<string>", "file_name": "<string>", "file_name_extension": "<string>", "config_id": "<string>", "processing": { "user_prompt": "<string>", "doc_processing_config": { "page_index": "<string>", "head_foot": false, "layout_position": false, "image_caption": false }, "media_processing_config": { "enable_diarization": false, "enable_synopsis_parse": false, "enable_synopsis_segments": false, "enable_synopsis_summary": false, "frame_extraction": { "mode": "auto", "frame_rate": 0, "output_image_width": 0, "output_image_height": 0 } } }, "output": { "output_file_format": [ "markdown" ], "layout_table_format": "markdown", "oss_config": { "bucket": "<string>", "endpoint": "<string>", "access_key_id": "<string>", "access_key_secret": "<string>", "security_token": "<string>" } } } '
{ "request_id": "<string>", "data": { "biz_id": "<string>" } }
提交文档或音视频解析任务，返回 biz_id。文档解析为异步任务：提交文件获得 biz_id，再使用该 ID 调用查询解析结果获取处理状态和结果。
调用前请确保已获取 API Key，详见鉴权。

请求参数

参数类型必填说明
file_urlstring是待解析文件的 URL。
file_namestring否文件名称。协议同时提供 file_name_extension，二者按文件信息填写方式二选一。
file_name_extensionstring否文件类型。与 file_name 二选一。
config_idstring否配置 ID。例如 config_xxx，与内联参数同时传递时内联参数优先生效。
processingobject否处理配置。
processing.user_promptstring否用户自定义 Prompt。
processing.doc_processing_configobject否文档解析处理配置。
processing.doc_processing_config.page_indexstring否解析页数范围。例如 1-10。
processing.doc_processing_config.head_footboolean否是否解析页眉和页脚。
processing.doc_processing_config.layout_positionboolean否是否返回坐标。
processing.doc_processing_config.image_captionboolean否是否生成图片描述。
processing.media_processing_configobject否音视频解析处理配置。
processing.media_processing_config.enable_diarizationboolean否是否进行人声分离。
processing.media_processing_config.enable_synopsis_parseboolean否是否进行剧情解析。
processing.media_processing_config.enable_synopsis_segmentsboolean否是否生成剧情解析段落。
processing.media_processing_config.enable_synopsis_summaryboolean否是否生成剧情解析摘要。
processing.media_processing_config.frame_extractionobject否抽帧配置。
processing.media_processing_config.frame_extraction.modestring否抽帧模式。可选值：auto、frame_rate
processing.media_processing_config.frame_extraction.frame_ratenumber否抽帧帧率，范围为 0.2～5
processing.media_processing_config.frame_extraction.output_image_widthinteger否输出帧图像宽度。不指定时使用原始分辨率，取值范围 [32, 4096]
processing.media_processing_config.frame_extraction.output_image_heightinteger否输出帧图像高度。不指定时使用原始分辨率，取值范围 [32, 4096]
outputobject否输出配置。
output.output_file_formatstring[]否输出格式字符串数组。可选值：markdown
output.layout_table_formatstring否Markdown 中表格的输出格式。可选值：markdown、html
output.oss_configobject否OSS 输出配置。
output.oss_config.bucketstring否托管 OSS Bucket 名称。
output.oss_config.endpointstring否托管 OSS Endpoint。
output.oss_config.access_key_idstring否托管 OSS AccessKey ID。
output.oss_config.access_key_secretstring否托管 OSS AccessKey Secret。
output.oss_config.security_tokenstring否托管 OSS Security Token。

返回结果

字段类型说明
request_idstring请求 ID
data.biz_idstring业务任务 ID，用于调用 /parse/result

文档解析代码示例

以下示例分别展示两种处理定义， config_id 与 processing 同时存在时，processing 会优先生效。示例中的 URL、任务 ID 和配置 ID 均为脱敏占位值。
  • 使用已保存的配置
  • 使用内联配置
通过
curl -X POST 'https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x/parse/submit' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "file_url": "https://example.com/document.pdf",
    "file_name": "document.pdf",
    "config_id": "config_xxx"
}'

{
    "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "data": {
        "biz_id": "parseX-2026xxxx-xxxxxxx"
    }
}

音视频解析代码示例

  • 使用已保存的配置
  • 使用内联配置
通过
curl -X POST 'https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x/parse/submit' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "file_url": "https://docmind-api-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/static/Wan3.0模型创意视频.mp4",
    "file_name": "test.mp4",
    "config_id": "config_xxx"
}'

{
    "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "data": {
        "biz_id": "parseX-Video-2026xxxx-xxxxxxx"
    }
}
提交后，使用查询解析结果轮询任务状态并获取解析结果。

Authorizations

​
string
header
required

Body

application/json
​
string
required

待解析文件的可访问 URL

​
string

文件名。协议同时提供 file_name_extension，二者按文件信息填写方式二选一

​
string

文件类型。与 file_name 二选一

​
string

配置 ID，例如 config_xxx。与内联参数同时传递时内联参数优先生效。

​
object

处理配置

​
object

输出配置

Response

200-application/json
​
string

请求 ID

​
object