## 接口简介用户可通过涂抹、选区等方式建立重绘区域，调用算法重新绘制。此功能为支持输入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=](https://visual.volcengineapi.com?Action=CVProcess&Version=2022-08-31)[CVProcess](https://visual.volcengineapi.com?Action=CVProcess&Version=2022-08-31)[&Version=2022-08-31](https://visual.volcengineapi.com?Action=CVProcess&Version=2022-08-31) ::: |参数 |可选/必选 |类型 |说明 | |---|---|---|---| |Action |必选 |String |接口名，取值：**CVProcess** | |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 |服务标识| |\ | | | |取固定值: **img2img_inpainting_edit_zi2i** | | |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中文字/英文单词以内，超出部分对生成效果影响较小，此字段会过审核 | | |return_url |可选 |bool |输出是否返回图片链接 **（链接有效期为24小时）** | | |steps |可选 |int |采样步数，生成图像的精细程度，越大效果可能更好，但相应的耗时会剧增| |\ | | | |默认值：25 | | |scale |可选 |float |取值范围[1, 20]，影响文本描述的程度| |\ | | | |默认值：5 | | |seed |可选 |int |随机种子，作为确定扩散初始状态的基础，非负数(\-1表示随机种子)。若随机种子为相同正整数且其他参数均一致，则生成图片极大概率效果一致| |\ | | | |默认值：\-1 | | |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) #### **业务返回参数** :::tip 重点关注data 字段，其他字段为公共返回 ::: |字段 |类型 |说明 |备注 | |---|---|---|---| |binary_data_base64 |Array of String |输出处理过的图片Base64数组（单张图） | | |image_urls |Array of String |输出处理过的图片url| |\ | | |数组（单张图） | | ## 请求&返回Body部分完整示例 ### **请求示例** ```json { "req_key": "img2img_inpainting_edit_zi2i", "binary_data_base64": ["原图", "原图标注后的mask"], "custom_prompt": "一只小狗", // 写入Prompt，AIGC生成取代的内容 "scale": 5, "seed": -1, "steps": 25 } ``` ### **输出示例** ```json { "code": 10000, "data": { "algorithm_base_resp": { "status_code": 0, "status_message": "Success" }, "binary_data_base64": ["编辑后的图base64"], "image_urls":["编辑后的图url"], "request_id": "d1741fd2176ae73ea6e17ae911bc81a5d6848449357c7024fe3be30701412726" }, "message": "Success", "request_id": "2024031414442379E5503DD25AA800AB0F", "status": 10000, "time_elapsed": "2.173378731s" } ``` ## 错误码 ### **通用错误码** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) ### **业务错误码** |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) ### HTTP方式接入说明请参考[HTTP请求示例](https://www.volcengine.com/docs/6444/1390583)

智能视觉服务