1. 接口描述
接口请求域名: aiart.tencentcloudapi.com 。
局部消除接口通过图像 mask 指定需要消除的人、物、文字等区域,在选定区域对图像内容进行消除与重绘补全。
默认提供1个并发,代表最多能同时处理1个已提交的任务。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ImageInpaintingRemoval。 |
Version | 是 | String | 公共参数,本接口取值:2022-12-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InputImage | 否 | String | 输入图 Base64 数据。 Base64 和 Url 必须提供一个,如果都提供以 Url 为准。 图片限制:单边分辨率小于5000,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。 示例值:9j/4QlQaHR0c...N6a2M5ZCI |
InputUrl | 否 | String | 输入图 Url。 Base64 和 Url 必须提供一个,如果都提供以 Url 为准。 图片限制:单边分辨率小于5000,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。 示例值:https://xxx.com/image.jpg |
Mask | 否 | String | 消除区域 Mask 图 Base64 数据。 Mask 为单通道灰度图,待消除部分呈白色区域,原图保持部分呈黑色区域。 Mask 的 Base64 和 Url 必须提供一个,如果都提供以 Url 为准。 图片限制:Mask 分辨率需要和输入原图保持一致,转成 Base64 字符串后小于 6MB。 示例值:9j/4QlQaHR0c...N6a2M5ZCI |
MaskUrl | 否 | String | 消除区域 Mask 图 Url。 Mask 为单通道灰度图,待消除部分呈白色区域,原图保持部分呈黑色区域。 Mask 的 Base64 和 Url 必须提供一个,如果都提供以 Url 为准。 图片限制:Mask 分辨率需要和输入原图保持一致,转成 Base64 字符串后小于 6MB。 示例值:https://xxx.com/mask.jpg |
RspImgType | 否 | String | 返回图像方式(base64 或 url) ,二选一,默认为 base64。url 有效期为1小时。 示例值:url |
LogoAdd | 否 | Integer | 为生成结果图添加标识的开关,默认为1。 1:添加标识。 0:不添加标识。 其他数值:默认按1处理。 建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。 示例值:1 |
LogoParam | 否 | LogoParam | 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。 示例值:{"LogoUrl": "https://xxx.com/logo.jpg", "LogoRect": {"X": 10, "Y": 10, "Width": 20, "Height": 20}} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ResultImage | String | 根据入参 RspImgType 填入不同,返回不同的内容。 如果传入 base64 则返回生成图 Base64 编码。 如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。 示例值:https://xxx.com/image.jpg |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用示例
输入示例
POST / HTTP/1.1
Host: aiart.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImageInpaintingRemoval
<公共请求参数>
{
"InputUrl": "https://xxx.com/image.jpg",
"MaskUrl": "https://xxx.com/mask.jpg",
"RspImgType": "url"
}
输出示例
{
"Response": {
"ResultImage": "https://aiart-xxx.cos.ap-guangzhou.myqcloud.com/xxx.jpg?q-sign-algorithm=sha1&q-ak=xxxxx&q-sign-time=1731574045;1731577645&q-key-time=1731574045;1731577645&q-header-list=host&q-url-param-list=&q-signature=31fe75c1c18c3d91db59508961209dd37aaf41c7",
"RequestId": "301bfc25-61ca-4ece-b03e-f6aefb547969"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。