最近更新时间:2023.05.19 16:30:11
首次发布时间:2021.11.29 19:44:20
针对上传的静图,支持去除上传图像背景,获取图像主体并设置主体轮廓描边的相关配置,如描边颜色、描边宽度。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 openAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称。 |
Version | String | 是 | 接口版本。veImageX 当前API的版本为2018-08-01。 |
ServiceId | String | 是 | 服务 ID。 |
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
Class | String | 是 | 图片类型,支持可选择的模型如下。
|
Refine | Bool | 是 | 处理效果,当
|
Contour | Object of Contour | 否 | 描边设置,仅当 |
TransBg | Bool | 否 | 是否开启透明背景裁剪设置。默认false,关闭状态。如果开启,抠出的结果图会被裁剪到刚好包住保留的图像主体。 |
StoreUri | String | 否 | 待擦除原图的存储 URI 和 URL(公网可访问的 URL)。 |
OutFormat | String | 是 | 输出图片格式,取值如下所示:
|
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
Color | String | 是 | 描边颜色,支持以 HEX、HSL、RGP 表示。例如HEX 中白色为#FFFFFF 。 |
Size | Integer | 是 | 描边宽度,单位为 px。取值范围为 0 到正整数,默认 10px。 |
参数 | 类型 | 描述 |
---|---|---|
ResUri | String | 背景去除后的图片 URI。 |
POST https://imagex.volcengineapi.com? Action=GetSegmentImage&ServiceId=example&Version=2018-08-01 { "Class" :"product", "Refine": true, "StoreUri":"tos-boe-i-example/6f90d0897.jpeg", "OutFormat":"jpeg" }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "GetSegmentImage", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1" }, "Result": { "Uri": "tos-boe-i-example/82d7f7e8a" } }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "GetSegmentImage", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1", "Error": { "Code": "xx", "Message": "xx" } } }
为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: