## 介绍当前商品下的能力已支持通过同步转异步接口进行异步调用，整个调用流程分为两个步骤：1. 使用CVSync2AsyncSubmitTask接口提交任务；2. 使用CVSync2AsyncGetResult接口查询任务结果。如有异步调用的需求，可参考本文档中**提交任务**与**查询任务**两个章节的示例进行调用。 ## 能力列表本商品下的能力都已支持同步转异步接口调用，下方列表中列举了部分能力 |**序号** |**能力接口文档** | |---|---| |1 |[通用2.1-文生图](https://www.volcengine.com/docs/86081/1804467?lang=zh) | |2 |[通用2.0Pro-指令编辑（SeedEdit）](https://www.volcengine.com/docs/86081/1804470?lang=zh) | |3 |[通用2.0Pro-文生图](https://www.volcengine.com/docs/86081/1804471?lang=zh) | |4 |[通用2.0-角色特征保持](https://www.volcengine.com/docs/86081/1804473?lang=zh) | |5 |[通用2.0-文生图](https://www.volcengine.com/docs/86081/1804474?lang=zh) | |6 |[通用1.4-角色特征保持](https://www.volcengine.com/docs/86081/1804477?lang=zh) | |7 |[通用1.4-文生图](https://www.volcengine.com/docs/86081/1804478?lang=zh) | |8 |[动漫1.3.X-文生图/图生图](https://www.volcengine.com/docs/86081/1804479?lang=zh) | |9 |[通用XL pro-图生图](https://www.volcengine.com/docs/86081/1804481?lang=zh) | |10 |[通用XL pro-文生图](https://www.volcengine.com/docs/86081/1804482?lang=zh) | |11 |[单图写真（pv版）](https://www.volcengine.com/docs/86081/1804488?lang=zh) | |12 |[inpainting涂抹消除](https://www.volcengine.com/docs/86081/1804489?lang=zh) | |13 |[inpainting涂抹编辑](https://www.volcengine.com/docs/86081/1804490?lang=zh) | |14 |[outpainting智能扩图](https://www.volcengine.com/docs/86081/1804491?lang=zh) | |15 |...... | ## 提交任务 ### **提交任务请求参数** #### **Header参数** 完整公共参数列表见 [公共参数](https://www.volcengine.com/docs/6369/67268) 本服务**Region为**cn\-north\-1； **Service为**cv #### **Query参数** > 拼接到url后的参数，示例：[https://visual.volcengineapi.com](https://visual.volcengineapi.com/) **?Action=CVSync2AsyncSubmitTask&Version=2022\-08\-31** |参数 |可选/必选 |类型 |说明 | |---|---|---|---| |Action |必选 |String |接口名，固定值：|\ | | | |**CVSync2AsyncSubmitTask** | |Version |必选 |String |版本号，固定值：**2022\-08\-31** | #### **请求示例** 请在**能力列表**中找到对应能力的接口文档，参考接口文档进行传参。下方示例为参考**通用2.0Pro\-文生图**进行传参。注：在提交任务时无需传入`return_url` 与`logo_info` 参数。 ```JSON { "req_key":"high_aes_general_v20_L", "prompt":"千军万马", "model_version":"general_v2.0_L", "seed":-1, "scale":3.5, "ddim_steps":16, "width":512, "height":512, "use_sr":true, } ``` ### 提交任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务输出参数** 重点关注data 字段，其他字段为公共返回 |字段 |类型 |说明 | |---|---|---| |task_id |String |任务ID，用于查询结果 **（task_id有效期为24小时）** | #### **返回示例** ```JSON { "code": 10000, //状态码，优先判断 code=10000, 然后再获取data.task_id，否则解析有可能会panic "data": { "task_id": "7392616336519610409" //查询任务所需的任务ID }, "message": "Success", //错误信息 "request_id": "20240720103939AF0029465CF6A74E51EC", //排查错误的关键信息 "time_elapsed": "104.852309ms" //链路耗时 } ``` ## 查询任务 ### **查询任务请求参数** #### **Header参数** 完整公共参数列表见 [公共参数](https://www.volcengine.com/docs/6369/67268) 本服务**Region为**cn\-north\-1； **Service为**cv #### **Query参数** > 拼接到url后的参数，示例：[https://visual.volcengineapi.com](https://visual.volcengineapi.com/) **?Action=CVSync2AsyncGetResult&Version=2022\-08\-31** |参数 |可选/必选 |类型 |说明 | |---|---|---|---| |Action |必选 |String |接口名，固定值：|\ | | | |**CVSync2AsyncGetResult** | |Version |必选 |String |版本号，固定值：**2022\-08\-31** | #### **Body参数** > 业务请求参数，放到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 |水印信息 | | |aigc_meta |可选 |AIGCMeta |隐式标识 |隐式标识验证方式：|\ | | | | ||\ | | | | |1. 查看【png】或【mp4】格式，人工智能生成合成内容表示服务平台（后续预计增加jpg）|\ | | | | |* [https://www.gcmark.com/web/index.html#/mark/check/image](https://www.gcmark.com/web/index.html#/mark/check/image)|\ | | | | |2. 查看【jpg】格式，使用app11 segment查看aigc元数据内容|\ | | | | |* 如 [https://cyber.meme.tips/jpdump/#](https://cyber.meme.tips/jpdump/#) | ##### **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表示完全不透明，默认1 | |logo_text_content |String |否 |明水印自定义内容 | ##### AIGCMeta 隐式标识，依据《人工智能生成合成内容标识办法》&《网络安全技术人工智能生成合成内容标识方法》 |名称 |类型 |**可选/必选** |描述 | |---|---|---|---| |content_producer |String |可选 |内容生成服务ID | |producer_id |String |必选 |内容生成服务商给此图片数据的唯一ID | |content_propagator |String |可选 |内容传播服务商ID | |propagate_id |String |可选 |传播服务商给此图片数据的唯一ID | #### **请求示例** 下方示例中`req_key`参数为参考**通用2.0Pro\-文生图**接口文档中的算法名称进行传参。 ```JSON { "req_key": "high_aes_general_v20_L", "task_id": "7418049665255653414", "req_json": "{\"logo_info\":{\"add_logo\":false,\"position\":0,\"language\":0,\"opacity\":1,\"logo_text_content\":\"这里是明水印内容\"},\"return_url\":true,\"aigc_meta\":{\"content_producer\":\"xxx\",\"producer_id\":\"xxx\",\"content_propagator\":\"xxx\",\"propagate_id\":\"xxx\"}}" } ``` ### 查询任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务输出参数** > 重点关注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小时)|\ | | |expired：任务已过期，请尝试重新提交任务请求 | #### **返回示例** ```JSON { "code": 10000, //状态码，优先判断 code=10000, 然后再判断data.status，否则解析有可能会panic "data": { "binary_data_base64": null, "image_urls": [ "https://xxxx", // ... ], "status": "done" //任务状态 }, "message": "Success", "request_id": "2025061718460554C9B78D23B0BAB45B2A", //排查错误的关键信息 "time_elapsed": "508.312154ms" //链路耗时 } ``` #### **返回报错示例** ```JSON { "code": 50413, //状态码，优先判断 code=10000, 然后再判断data.status，否则解析有可能会panic "data": null, //code!=10000的情况下，该字段返回为null "message": "Post Text Risk Not Pass", //错误信息 "request_id": "202511281418218670D408837A9B0EB58F", //排查错误的关键信息 "time_elapsed": "36.799829ms" //链路耗时 } ``` ## 错误码 ### （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)

图像生成大模型