使用智能图像扩展获取结果图

最近更新时间：2023.05.19 15:49:36

首次发布时间：2021.11.29 19:44:20

本接口支持通过指定服务 ID、原图地址以及智能图像扩展模型，得到处理后的结果图 URI。

请求说明

接口名称：GetImageBgFillResult
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=GetImageBgFillResult&Version=2018-08-01
请求频率限制：100 次/秒
超时时间：20 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必填	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前`API`的版本为`2018-08-01`。

Body

参数	类型	是否必填	描述
ServiceId	String	是	服务`ID`。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
StoreUri	String	是	待填充原图的存储 URI 和 URL（公网可访问的 URL）。
Model	Integer	是	填充模型，取值如下所示： 0：国漫风格模型； 1：通用模型。
Top	Float	否	向上填充比例，取值范围为 [0, 0.4]。
Bottom	Float	否	向下填充比例，取值范围为 [0, 0.4]。
Left	Float	否	向左填充比例，取值范围为 [0, 0.4]。
Right	Float	否	向右填充比例，取值范围为 [0, 0.4]。

返回参数

参数	类型	描述
ResUri	String	填充结果图的 URI。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageBgFillResult&Version=2018-08-01
{
   "Model":0,
   "Top":0.15,
   "Bottom":0.15,
   "ServiceId":"ln***tb",
   "StoreUri":"imagex-common/b9***77"
}

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"2022082411381601021119922119000D90",
      "Action":"GetImageBgFillResult",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "ResUri":"tos-cn-i-ln***tb/97***e9"
   }
}

异常返回示例

{
		"ResponseMetadata": {
				"RequestId": "201806041104200100100232280022D30",
				"Action": "GetImageBgFillResult",
				"Version": "2018-08-01",
				"Service": "imagex",
				"Region": "cn-north-1",
				"Error": {
						"Code": "",
						"Message": ""
        }
		}
}

错误码

访问错误码和附加组件错误码获取详细信息。

服务端 SDK

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