# 接口简介待补充 # 接入说明 ## 请求说明 |名称 |内容 | |---|---| |接口地址 |[https://visual.volcengineapi.com](https://visual.volcengineapi.com/) | |请求方式 |POST | |Content\-Type |application/json | ## 提交任务 ### **提交任务请求参数** #### **Query参数** :::tip 拼接到url后的参数，示例：[https://visual.volcengineapi.com?Action=CVSync2AsyncSubmitTask&Version=2022-08-31](https://visual.volcengineapi.com?Action=CVSync2AsyncSubmitTask&Version=2022-08-31) ::: |参数 |类型 |**可选/必选** |说明 | |---|---|---|---| |Action |string |必选 |接口名，取值：**CVSync2AsyncSubmitTask** | |Version |string |必选 |版本号，取值：2022\-08\-31 | #### **Header参数** :::warning 本服务固定值：**Region为cn\-north\-1，Service为cv** ::: 主要用于鉴权，详见 [公共参数](https://www.volcengine.com/docs/6369/67268) \- 签名参数 \- 在Header中的场景部分 #### **Body参数** :::warning 业务请求参数，放到request.body中，MIME\-Type为**application/json** ::: |参数 |类型 |**可选/必选** |说明 | |---|---|---|---| |req_key |string |必选 |算法名称：**aip_x2v_seedance_dreamontage_cv** | |duration |int |可选 |生成的视频时长（单位：秒）|\ | | | |取值范围：[3, 54]|\ | | | |默认值：10|\ | | | |限制说明：|\ | | | ||\ | | | |* 生成的视频帧数为： duration \* 24 + 1|\ | | | |* 支持3～54秒，即73～1297帧|\ | | | |* 时长超出下限会设置为3秒|\ | | | |* 时长超出上限会设置为54秒 | |image_url_list |array of string |必选 |使用到的图片资源素材URL|\ | | | | |\ | | | |限制说明：|\ | | | ||\ | | | |* 资源素材总数量范围：[1, 6]，即 1 ≤ len(image_url_list) ≤ 6|\ | | | |* 资源素材的分辨率应 ≤ 1080p，图片素材应为jpg、png格式 | |media_index_list |int array 2D |必选 |资源素材与视频帧区间的映射|\ | | | |meidia_index_list是一个双层嵌套数组，结构示例：|\ | | | |```JSON|\ | | | |[|\ | | | | [x1, y1, 0], // 表示在结果视频的第x1帧至y1帧会使用到 image_url_list 中的第1个资源素材|\ | | | | [x2, y2, 0] // 表示在结果视频的第x2帧至y2帧会使用到 image_url_list 中的第2个资源素材|\ | | | |] |\ | | | |```|\ | | | ||\ | | | | |\ | | | |限制说明：|\ | | | ||\ | | | |* meidia_index_list的长度应等于资源素材总数量，即meidia_index_list长度|\ | | | |* x, y (帧范围) 取值区间：[0, duration \* 24 + 1)， x ≤ y|\ | | | |* 内层数组长度固定为3，且最后一个元素只能取值0，0表示从image_url_list取素材 | |user_prompt |map of string pair |可选 |提示词映射|\ | | | |user_prompt是一个key为字符串、value为字符串数组的map，其中key固定为indexes和prompts，结构示例：|\ | | | |```JSON|\ | | | |{|\ | | | | "indexes":["[x1,y1]","[x2,y2]"],|\ | | | | "prompts":["your prompt1","your prompt2"]|\ | | | |}|\ | | | |```|\ | | | ||\ | | | |indexes和prompts需要一一对应，上述示例表示在结果视频中的 [x1, y1]帧将参考提示词"your prompt1"生成， [x2, y2]帧将参考提示词"your prompt2"生成|\ | | | | |\ | | | |限制说明：|\ | | | ||\ | | | |* indexes和prompts需要一一对应，推荐数组长度为 len(image_url_list) \-1|\ | | | |* 每条提示词长度应在150字符以内。当不传user_prompt时，会随机生成一个prompt|\ | | | |* [x1, y1]，取值范围不超过总帧数，总帧数计算公式： duration \* 24 + 1 | |resolution |string |可选 |视频分辨率|\ | | | |可选取值：[480p, 720p]|\ | | | |默认值：480p | |seed |int |可选 |随机种子，作为确定扩散初始状态的基础，默认\-1（随机）。若随机种子为相同正整数且其他参数均一致，则生成视频极大概率效果一致|\ | | | |默认值：\-1 | ### 提交任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务返回参数** :::tip 重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析) ::: |字段 |类型 |说明 | |---|---|---| |task_id |string |任务ID，用于查询结果 | ### 提交任务请求&返回完整示例 **请求示例：** ```JSON { "req_key": "aip_x2v_seedance_dreamontage_cv", "duration": 10, "image_url_list": ["https://xxxx", "https://xxxx"], "media_index_list": [ [0, 0, 0], [96, 128, 0], ], "user_prompt": { "indexes":["[24,96]", "[96,128]"], "prompts":["男人走进画面拿起背包", "包里的书掉到了地上"] }, "resolution": "480p", "seed": -1 } ``` **返回示例：** ```JSON { "code": 10000, "data": { "task_id": "7392616336519610409" }, "message": "Success", "request_id": "20240720103939AF0029465CF6A74E51EC", "status": 10000, "time_elapsed": "104.852309ms" } ``` ## 查询任务 ### **查询任务请求参数** #### **Query参数** :::tip 拼接到url后的参数，示例：[https://visual.volcengineapi.com](https://visual.volcengineapi.com/)[?Action=CVSync2AsyncGetResult&Version=2022-08-31](https://visual.volcengineapi.com?Action=CVGetResult&Version=2022-08-31) ::: |参数 |类型 |**可选/必选** |说明 | |---|---|---|---| |Action |string |必选 |接口名，固定值：**CVSync2AsyncGetResult** | |Version |string |必选 |版本号，固定值：**2022\-08\-31** | #### **Header参数** :::warning 本服务固定值：**Region为cn\-north\-1，Service为cv** ::: 主要用于鉴权，详见 [公共参数](https://www.volcengine.com/docs/6369/67268) \- 签名参数 \- 在Header中的场景部分 #### **Body参数** :::warning 业务请求参数，放到request.body中，MIME\-Type为**application/json** ::: |参数 |类型 |**可选/必选** |说明 | |---|---|---|---| |req_key |string |必选 |服务标识|\ | | | |取固定值: **aip_x2v_seedance_dreamontage_cv** | |task_id |string |必选 |任务ID，此字段的取值为**提交任务接口**的返回 | ##### ### 查询任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务返回参数** :::tip 重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析) ::: |参数名 |类型 | | |---|---|---| |video_url |string |生成的视频URL | |status |string |任务执行状态|\ | | ||\ | | |* in_queue：任务已提交|\ | | |* generating：任务已被消费，处理中|\ | | |* done：处理完成，成功或者失败，可根据外层code&message进行判断|\ | | |* not_found：任务未找到，可能原因是无此任务或任务已过期(12小时)|\ | | |* expired：任务已过期，请尝试重新提交任务请求 | ### 查询任务请求&返回完整示例 **请求示例：** ```JSON { "req_key": "aip_x2v_seedance_dreamontage_cv", "task_id": "7491596536074305586" } ``` **返回示例：** ```JSON { "code": 10000, "data": { "status": "done", "video_url": "https://xxxx" }, "message": "Success", "request_id": "20250805144938F6E5264E9D24EB0C4E0A", "status": 10000, "time_elapsed": "57.354545ms" } ``` ## 错误码 ### **通用错误码** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) ### **业务错误码** |HttpCode |错误码 |错误消息 |描述 |是否需要重试 | |---|---|---|---|---| |200 |10000 |无 |请求成功 |不需要 | |400 |50411 |Pre Img Risk Not Pass |输入图片前审核未通过 |不需要 | |400 |50511 |Post Img Risk Not Pass |输出图片后审核未通过 |可重试 | |400 |50412 |Text Risk Not Pass |输入文本前审核未通过 |不需要 | |400 |50512 |Post Text Risk Not Pass |输出文本后审核未通过 |不需要 | |400 |50413 |Post Text Risk Not Pass |输入文本含敏感词、版权词等审核不通过 |不需要 | |429 |50429 |Request Has Reached API Limit, Please Try Later |QPS超限 |可重试 | |429 |50430 |Request Has Reached API Concurrent Limit, Please Try Later |并发超限 |可重试 | |500 |50500 |Internal Error |内部错误 |可重试 | |500 |50501 |Internal RPC Error |内部算法错误 |可重试 | ## 接入说明 ### SDK使用说明请参考[SDK使用说明](https://www.volcengine.com/docs/6444/1340578) ### HTTP方式接入说明请参考[HTTP请求示例](https://www.volcengine.com/docs/6444/1390583)

智能视觉服务