## 接口简介用户可通过涂抹、选区等方式建立重绘区域，调用算法重新绘制。此功能为支持输入prompt的涂抹编辑功能，按照prompt生成指定内容。考虑效果更优，建议一次性给客户返回3\-4个效果供客户进行挑选。 |![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_eaf7c0fb210e0996af62575684a9725e.png =1584x) \* |![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_40a0e87e42be591c49867efb84a8e895.png =1480x) |![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_144bb804f17c38e3bbaea581f5dc5250.png =1498x) | |---|---|---| |调用分割接口，识别主体，将主体进行编辑 |调用分割接口，识别背景，将背景进行编辑 |用户自己主动涂抹选择指定区域，将涂抹位置进行编辑 | ## 限制条件 |名称 |内容 | |---|---| |图片要求 |**输入图要求：** |\ | |1.图片格式：仅支持JPG、JPEG、PNG格式，建议使用JPG格式。|\ | |2.图片文件大小：最大 5 MB。|\ | |3.图片分辨率：最小 64x64，最大 4096x4096|\ | |**mask图要求：** |\ | |1.单通道灰度图（0～255）|\ | |2.三通道图片，rgb值相等|\ | |3.rgba 4通道，rgb值相等，a通道全为255|\ | |4.文件格式：8bt png编码，勿嵌入“描述文件（ICC Profile）” | ## Demo展示 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_5d63833a0d2278f1aca3119730717ef3.png =1638x) ## 请求说明 |名称 |内容 | |---|---| |接口地址 |[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 |取值: i2i_inpainting_edit | |binary_data_base64 |必选（二选一） |Array of String |输入图片base64数组：|\ | | | |0：输入图片，三通道RGB图|\ | | | |1：输入mask，单通道灰度图，原图保持部分对应0(即黑色区域)，待消除区域对应255(即白色区域) | |image_urls |必选（二选一） |Array of String |输入图片url数组：|\ | | | |0：输入图片，三通道RGB图|\ | | | |1：输入mask，单通道灰度图，原图保持部分对应0(即黑色区域)，待消除区域对应255(即白色区域) | |custom_prompt |可选 |string |用于生成图像的提示词，支持中英文输入，建议内容简洁准确，控制在100中文字/英文单词以内，超出部分对生成效果影响较小，此字段会过审核 | |steps |可选 |int |采样步数，生成图像的精细程度，越大效果可能更好，但相应的耗时会剧增|\ | | | |默认值：25 | |scale |可选 |float |取值范围[1, 20]，影响文本描述的程度|\ | | | |默认值：5 | |seed |可选 |int |随机种子，作为确定扩散初始状态的基础，非负数(\-1表示随机种子)。若随机种子为相同正整数且其他参数均一致，则生成图片极大概率效果一致|\ | | | |默认值：\-1 | 提交任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务返回参数** :::tip 重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析) ::: |字段 |类型 |说明 | |---|---|---| |task_id |string |任务ID，用于查询结果 | ### 提交任务请求&返回完整示例 **请求示例：** ```JSON { "binary_data_base64": ["原图", "原图标注后的mask"], "custom_prompt": "一只小狗", // 写入Prompt，AIGC生成取代的内容 "req_key": "i2i_inpainting_edit", "scale": 5, "seed": -1, "steps": 25 } ``` **返回示例：** ```JSON { "code": 10000, //状态码，优先判断 code=10000, 然后再获取data.task_id，否则解析有可能会panic "data": { "task_id": "7392616336519610409" //查询任务所需的任务ID }, "message": "Success", //错误信息 "request_id": "20240720103939AF0029465CF6A74E51EC", //排查错误的关键信息 "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 |必选 |服务标识|\ | | | |取固定值: i2i_inpainting_edit | |task_id |string |必选 |任务ID，此字段的取值为**提交任务接口**的返回 | |req_json |JSON string |可选 |json序列化后的字符串|\ | | | |目前支持水印配置和是否以图片链接形式返回，可在返回结果中添加|\ | | | |示例："{\"logo_info\":{\"add_logo\":true,\"position\":0,\"language\":0,\"opacity\":1,\"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 |bool |可选 |是否添加水印。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 | ### 查询任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务返回参数** :::tip 重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析) ::: |参数名 |参数说明 |参数示例 | |---|---|---| |binary_data_base64 |array of string |返回图片的base64数组。 | |image_urls |array of string |返回图片的url数组，输出图片格式为jpeg格式（有效期为 24 小时） | |status |string |任务执行状态|\ | | ||\ | | |* in_queue：任务已提交|\ | | |* generating：任务已被消费，处理中|\ | | |* done：处理完成，成功或者失败，可根据外层code&message进行判断|\ | | |* not_found：任务未找到，可能原因是无此任务或任务已过期(12小时)|\ | | |* expired：任务已过期，请尝试重新提交任务请求 | ### 查询任务请求&返回完整示例 **请求示例：** ```JSON { "req_key": "i2i_inpainting_edit", "task_id": "<任务提交接口返回task_id>", "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\"}}" } ``` **返回示例：** ```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, //状态码 "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）业务错误码** |http code |错误码 |错误信息 |说明 | |---|---|---|---| |200 |10000 |Success |成功 | |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)

图像生成大模型