## 介绍当前商品下的能力已支持通过同步转异步接口进行异步调用，整个调用流程分为两个步骤：1. 使用CVSync2AsyncSubmitTask接口提交任务；2. 使用CVSync2AsyncGetResult接口查询任务结果。如有异步调用的需求，可参考本文档中**提交任务**与**查询任务**两个章节的示例进行调用。 ## 能力列表本商品下的能力都已支持同步转异步接口调用，下方列表中列举了部分能力 |**序号** |**能力接口文档** | |---|---| |1 |[通用3.0-文生图](https://www.volcengine.com/docs/85128/1526761) | |2 |...... | ## 提交任务 ### **提交任务请求参数** #### **Header参数** :::warning 本服务固定值：**Region为cn\-north\-1，Service为cv** ::: 主要用于鉴权，详见 [公共参数](https://www.volcengine.com/docs/6369/67268) \- 签名参数 \- 在Header中的场景部分 #### **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** | #### **请求示例** 请在**能力列表**中找到对应能力的接口文档，参考接口文档**Body参数**进行传参。下方示例为参考**通用3.0\-文生图**进行传参。 :::warning 在提交任务时无需传入`return_url` 与`logo_info` 参数，应在查询任务时传入。 ::: ```JSON { "req_key": "high_aes_general_v30l_zt2i", "prompt": "千军万马", "seed": -1, "scale": 2.5, "width": 1328, "height": 1328 } ``` ### 提交任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务输出参数** :::tip 重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析) ::: |字段 |类型 |说明 | |---|---|---| |task_id |String |任务ID，用于查询结果 **（task_id有效期为24小时）** | #### **返回示例** ```JSON { "code": 10000, "data": { "task_id": "7418048504813240370" }, "message": "Success", "request_id": "2024092411365866C579D2A96A35DA62A9", "status": 10000, "time_elapsed": "23.099216ms" } ``` ## 查询任务 ### **查询任务请求参数** #### **Header参数** :::warning 本服务固定值：**Region为cn\-north\-1，Service为cv** ::: 主要用于鉴权，详见 [公共参数](https://www.volcengine.com/docs/6369/67268) \- 签名参数 \- 在Header中的场景部分 #### **Query参数** :::tip 拼接到url后的参数，示例：[https://visual.volcengineapi.com?Action=CVSync2AsyncGetResult&Version=2022-08-31](https://visual.volcengineapi.com?Action=CVSync2AsyncGetResult&Version=2022-08-31) ::: |参数 |可选/必选 |类型 |说明 | |---|---|---|---| |Action |必选 |String |接口名，固定值：|\ | | | |**CVSync2AsyncGetResult** | |Version |必选 |String |版本号，固定值：**2022\-08\-31** | #### **Body参数** :::warning 业务请求参数，放到request.body中，MIME\-Type为**application/json** ::: |参数 |可选/必选 |类型 |说明 |示例 | |---|---|---|---|---| |req_key |必选 |String |算法名称，请在**能力列表**中找到对应能力的接口文档，**参考接口文档中的算法名称进行传参** | | |task_id |必选 |String |任务ID，此字段为**提交任务接口中返回的task_id** | | |req_json |可选 |JSON String |**json序列化后的字符串**|"{"logo_info":{"add_logo":true,"position":0,"language":0,"logo_text_content":"这里是明水印内容"},"return_url":true}" |\ | | | |目前支持水印配置和是否以图片链接形式返回，可在返回结果中添加 | | ##### **ReqJson(序列化后的结果再赋值给req_json)** 配置信息 |**参数** |**可选/必选** |**类型** |**说明** | |---|---|---|---| |return_url |可选 |bool |输出是否返回图片链接 **（链接有效期为24小时）** | |logo_info |可选 |LogoInfo |水印信息 | ##### **LogoInfo** 水印相关信息 |名称 |类型 |必选 |描述 | |---|---|---|---| |add_logo |Boolean |否 |是否添加水印。True为添加，False不添加。默认不添加 | |position |Int |否 |水印的位置，取值如下：|\ | | | |0\-右下角|\ | | | |1\-左下角|\ | | | |2\-左上角|\ | | | |3\-右上角|\ | | | |默认0 | |language |Int |否 |水印的语言，取值如下：|\ | | | |0\-中文（AI生成）|\ | | | |1\-英文（Generated by AI）|\ | | | |默认0 | |opacity |Float |否 |水印的不透明度，取值范围0\-1，1表示完全不透明，默认0.3 | |logo_text_content |String |否 |明水印自定义内容 | #### **请求示例** 下方示例中`req_key`参数为参考**通用3.0\-文生图**接口文档中的算法名称进行传参。 ```JSON { "req_key": "high_aes_general_v30l_zt2i", "task_id": "7418049665255653414", "req_json":"{\"logo_info\":{\"add_logo\":true,\"position\":0,\"language\":0,\"opacity\":0.3,\"logo_text_content\":\"这里是明水印内容\"},\"return_url\":true}" } ``` ### 查询任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务输出参数** :::tip 重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析) ::: |字段 |类型 |说明 | |---|---|---| |binary_data_base64 |Array of string |返回图片的base64数组。 | |image_urls |Array of string |返回图片的url数组 | |response_data |String |算法返回的一些信息，可忽略，是json序列化字符串 | |status |String |in_queue：任务已提交|\ | | |generating：任务已被消费，处理中|\ | | |done：处理完成，成功或者失败，可根据外层code&message进行判断|\ | | |not_found：任务未找到，可能原因是无此任务或任务已过期(12小时) | #### **返回示例** ```JSON { "code": 10000, "data": { "algorithm_base_resp": { "status_code": 0, "status_message": "Success" }, "binary_data_base64": [], "image_urls": [ "https://xxxx" ], "infer_ctx": { }, "llm_result": "", "pe_result": "", "predict_tags_result": "", "rephraser_result": "", "request_id": "9f049575e30035fa30415e594c20018b14f89b52b20ceb146abc93f3e6d379b9", "vlm_result": "" }, "message": "Success", "request_id": "20250403151503DD53B34623F59CF8B86D", "status": 10000, "time_elapsed": "3.9656567s" } ``` ## 错误码 ### （1）通用错误码请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) ### （2）业务错误码 |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 |输入文本NER、IP、Blocklist等拦截 | ## 接入说明 ### SDK使用说明请参考[SDK使用说明](https://www.volcengine.com/docs/6444/1340578) ### HTTP方式接入说明请参考[HTTP请求示例](https://www.volcengine.com/docs/6444/1390583)

智能视觉服务