## 接口简介通用2.0S模型（历史名称：通用2.0S模型），是原生中英文双语模型，模型在图文匹配度、美感上均有大幅提升。推荐在通用类别（不局限于人像人体）、效果要求极高、延迟要求较高的场景进行使用。强烈建议开启超分参数，开启后原输出宽高均会\*2 本服务为异步接口，免费试用状态的查询任务QPS为10，正式状态的查询任务QPS为20 ## 请求说明 |名称 |内容 | |---|---| |接口地址 |[https://visual.volcengineapi.com](https://visual.volcengineapi.com/) | |请求方式 |POST | |Content\-Type |application/json | ## 限制条件 |名称 |内容 | |---|---| |图片要求 |1. 图片格式：JPG(JPEG), PNG, BMP 等常见格式, 建议使用JPG格式. | ## 提交任务 ### **提交任务请求参数** #### **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** | #### **Body参数** > 业务请求参数，放到request.body中，MIME\-Type为**application/json** |参数 |可选/必选 |类型 |说明 |备注 | |---|---|---|---|---| |req_key |必选 |String |算法名称，取固定值为high_aes_general_v20 | | |prompt |必选 |String |用于生成图像的提示词，中英文均可输入 | | |model_version |必选 |String |模型版本名称，固定值：general_v2.0 | | |seed |可选 |int |随机种子，\-1为不随机种子；其他为指定随机种子| |\ | | | |默认值：\-1 | | |scale |可选 |float |影响文本描述的程度| |\ | | | |默认值：3.5 取值范围[1, 30] | | |ddim_steps |可选 |int |生成图像的步数| |\ | | | |默认值：16 取值范围[1\-50] | | |width |可选 |int |生成图像的宽，取值范围[256\-680]|宽、高与512差距过大，则出图效果不佳、延迟过长概率显著增加。|\ | | | |默认值：512 |超分前建议比例及对应宽高：width\*height|\ | | | | ||\ | | | | |* 1:1：512\*512|\ | | | | |* 4:3：512\*384|\ | | | | |* 3:4：384\*512|\ | | | | |* 3:2：512\*341|\ | | | | |* 2:3：341\*512|\ | | | | |* 16:9：512\*288|\ | | | | |* 9:16：288\*512 | |height |可选 |int |生成图像的高，取值范围[256\-680]|^^|\ | | | |默认值：512 | | |use_sr |可选 |Bool |True：文生图+AIGC超分|**建议开启超分参数**|\ | | | |False：文生图|内置的超分功能，开启后可将上述宽高均乘以2返回，此参数打开后延迟会有增加|\ | | | |默认值：True |如上述宽高均为512和512，此参数关闭出图 512\*512 ，此参数打开出图1024 \* 1024 | ### 提交任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务输出参数** 重点关注data 字段，其他字段为公共返回 |字段 |类型 |说明 | |---|---|---| |task_id |String |任务ID，用于查询结果 **（task_id有效期为24小时）** | ### 提交任务请求&返回完整示例 #### **请求示例：** ```json { "req_key":"high_aes_general_v20", "prompt":"千军万马", "model_version":"general_v2.0", "seed":-1, "scale":3.5, "ddim_steps":16, "width":512, "height":512, "use_sr":True } ``` #### **返回示例：** ```JSON { "code": 10000, "data": { "task_id": "7418048504813240370" }, "message": "Success", "request_id": "2024092411365866C579D2A96A35DA62A9", "status": 10000, "time_elapsed": "23.099216ms" } ``` ## 查询任务 ### **查询任务请求参数** #### **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 |算法名称，取固定值为high_aes_general_v20 | | |task_id |必选 |String |任务ID，此字段的取值为**提交任务接口**的返回 | | |req_json |可选 |JSON String |json序列化后的字符串|"{"logo_info":{"add_logo":true,"position":0,"language":0,"opacity":0.3,"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 |否 |明水印自定义内容 | | ### 查询任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](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小时) | ### 查询任务请求&返回完整示例 #### **请求示例：** ```json { "req_key": "high_aes_general_v20", "task_id": "7418049665255653414", "req_json":"{\"logo_info\":{\"add_logo\":true,\"position\":0,\"language\":0,\"opacity\":0.3,\"logo_text_content\":\"这里是明水印内容\"},\"return_url\":true}" } ``` #### **返回示例：** ```json { "code": 10000, "data": { "binary_data_base64": [], "image_urls": [ "https://xxx" ], "resp_data": "{\"pe_result\":\"\",\"predict_tags_result\":\"\",\"rephraser_result\":\"壮观的场景，展现了千军万马。画面中，穿着衣服的士兵们身着铠甲，手持长矛，整齐划一地行进在大地上。他们的身后是蓝天白云，而前方则是无尽的草原。\",\"request_id\":\"fffabb8c284a97530802576961c87939e9ab3b28b8a185f03e753420b1c9abe2\"}", "status": "done" }, "message": "Success", "request_id": "20240926173705355DAC3521C41B25CBE5", "status": 10000, "time_elapsed": "1.616183051s" } ``` ## 错误码 **（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)