You need to enable JavaScript to run this app.
导航
人像人体
  • 文档首页
    • /
  • 人像人体

inpainting涂抹编辑

最近更新时间：2024.03.18 22:06:39

首次发布时间：2024.03.12 10:33:48

我的收藏

接口简介

用户可通过涂抹、选区等方式建立重绘区域，调用算法重新绘制。此功能为支持输入prompt的涂抹编辑功能，按照prompt生成指定内容。考虑效果更优，建议一次性给客户返回3-4个效果供客户进行挑选。

调用分割接口，识别主体，将主体进行编辑调用分割接口，识别背景，将背景进行编辑用户自己主动涂抹选择指定区域，将涂抹位置进行编辑

限制条件

名称内容
图片要求1. 图片格式：仅支持JPG、JPEG、PNG格式，建议使用JPG格式。 
2. 图片文件大小：最大 5 MB。
3. 图片分辨率：最小 64*64，最大 4096*4096

Demo展示

alt

请求说明

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/json

请求参数

（1）header请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数

名称类型是否必填描述
X-DateString是使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z

Authorization

String

是

HMAC-SHA256：签名方法
-Credential为签名凭证，其中:
-AccessKeyId为访问密钥ID，可在 访问密钥（Access Key） 获取；
-ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201；
-Region为请求地区，国内一般为为cn-north-1；
-Service为请求的服务，一般为cv；
-SignedHeaders为参与签名计算的头部信息，content-type 和 host 为必选头部；
-Signature为签名，可在 签名方法 获取。
注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考 快速接入
例如：HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString否指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数
业务请求参数

参数可选/必选类型说明
Action必选String接口名，取值：Img2ImgInpaintingEdit
Version必选String版本号，取值：2022-08-31

（3）Body参数

业务请求参数

参数可选/必选类型说明
req_key必选String取值: i2i_inpainting_edit
binary_data_base64必选Array of String输入图片base64数组：
0：输入图片，三通道RGB图
1：输入mask，单通道灰度图，原图保持部分对应0(即白色区域)，待消除区域对应255(即黑色区域)
custom_prompt必选string用于生成图像的提示词，支持中英文输入，建议内容简洁准确，控制在100中文字/英文单词以内，超出部分对生成效果影响较小，此字段会过审核
steps可选int采样步数，生成图像的精细程度，越大效果可能更好，但相应的耗时会剧增
默认值：25
scale可选float取值范围[1, 20]，影响文本描述的程度
默认值：5
seed可选int随机种子，作为确定扩散初始状态的基础，非负数(-1表示随机种子)。若随机种子为相同正整数且其他参数均一致，则生成图片极大概率效果一致
默认值：-1

（4）请求示例

{
    "binary_data_base64": ["原图", "原图标注后的mask"],
    "custom_prompt": "一只小狗",  // 写入Prompt，AIGC生成取代的内容
    "req_key": "i2i_inpainting_edit",
    "scale": 5,
    "seed": -1,
    "steps": 25
}

输出说明

（1）通用输出参数

请参考通用返回字段及错误码

（2）业务输出参数

data 字段说明

字段类型说明备注
binary_data_base64Array of String输出处理过的图片Base64数组（单张图）

（3）输出示例

{
    "code": 10000,
    "data": {
        "algorithm_base_resp": {
            "status_code": 0,
            "status_message": "Success"
        },
        "binary_data_base64": ["编辑后的图base64"],
        "request_id": "d1741fd2176ae73ea6e17ae911bc81a5d6848449357c7024fe3be30701412726"
    },
    "message": "Success",
    "request_id": "2024031414442379E5503DD25AA800AB0F",
    "status": 10000,
    "time_elapsed": "2.173378731s"
}

错误码

（1）通用错误码

请参考通用返回字段及错误码

（2）业务错误码

http code错误码错误信息说明
20010000Success成功
40050411Pre Img Risk Not Pass输入图片前审核未通过
40050511Post Img Risk Not Pass输出图片后审核未通过
40050412Text Risk Not Pass输入文本前审核未通过
40050512Post Text Risk Not Pass输出文本后审核未通过
40050413Post Text Risk Not Pass输入文本NER、IP、Blocklist等拦截