文档中心

使用智能背景移除获取结果图

最近更新时间：2024.04.26 11:06:58

首次发布时间：2024.04.26 11:06:58

针对上传的静图，支持去除上传图像背景，获取图像主体并设置主体轮廓描边的相关配置，如描边颜色、描边宽度。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 30 秒。
前提条件：已开通智能背景移除组件能力
计费说明：智能背景移除功能属于增值服务项，故使用后会产生增值服务费用，当前支持后付费。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 openAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=GetSegmentImage&Version=2023-05-01

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数类型是否必选示例值描述

Action String 是 GetSegmentImage 接口名称。当前 API 的名称为 GetSegmentImage。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`GetSegmentImage`	接口名称。当前 API 的名称为 `GetSegmentImage`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`91**2g`	待处理图片对应的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

91**2g

待处理图片对应的服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
StoreUri	String	是	`tos-cn-i-example/6f90d0897.jpeg`	待擦除原图的存储 URI 或访问 URL（可公网访问）。您可在控制台资源管理获取图片的存储 URI 以及访问 URL。
Class	String	是	`product`	处理模型，支持可选择的模型如下。 `general`：通用模型v1 `human`：人脸模型v1 `product`：商品模型v1 `humanv2`：人脸模型v2 `productv2`：商品模型v2
Refine	Boolean	是	`true`	处理效果，当`Class`取值为`humanv2`或`productv2`时，默认为`true`。 `false`：保留的图像主体边缘以粗线条处理，图像处理的效率更高。 `true`：保留的图像主体边缘以发丝级细线条处理，图像处理后的效果更好。
Contour	Object of Contour	否	`-`	描边设置，仅当`Class`取值`humanv2`或`productv2`时配置有效。设置后，抠出的结果图中保留的图像主体会外包一圈描边效果。
TransBg	Boolean	否	`false`	是否开启透明背景裁剪设置，取值如下所示： `true`：开启，抠出的结果图会被裁剪到刚好包住保留的图像主体。 `false`：（默认）关闭
OutFormat	String	是	`jpeg`	指定输出图片的格式，取值如下所示： `png` `jpeg` `webp`

Contour

参数	类型	是否必选	示例值	描述
Color	String	是	`#FFFFFF`	描边颜色，支持以 HEX、HSL、RGP 表示。例如`HEX`中白色为`#FFFFFF`。
Size	Integer	是	`10`	描边宽度，单位为 px。取值范围为 0 到正整数，默认 10px。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ResUri	String	`tos-cn-i-9i**3g/example`	结果图 URI。您可使用结果图 URI（即 `ResUri`）拼接完整访问 URL 后，在浏览器查看背景移除效果。

请求示例

POST https://imagex.volcengineapi.com/?Action=GetSegmentImage&Version=2023-05-01&ServiceId=91**2g
{
  "Class": "product",
  "Refine": true,
  "StoreUri": "tos-cn-i-example/6f90d0897.jpeg",
  "OutFormat": "jpeg"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "GetSegmentImage",
    "Version": "2023-05-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "ResUri": "tos-cn-i-example/82d7f7e8a"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：