使用智能图像扩展获取结果图--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

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

最近更新时间：2024.08.14 11:44:50首次发布时间：2024.04.26 11:06:58

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

注意事项

计费说明：智能图像扩展功能属于附加组件下智能处理模块，属于后付费计费，使用后会产生附加组件智能处理费用。
前提条件：请确保已开通智能处理计费配置。
使用限制：使用组件前，请先确认智能图像扩展使用限制。
请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 20 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageBgFillResult`	接口名称。当前 API 的名称为 `GetImageBgFillResult`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
ServiceId	String	是	`ln***tb`	用于存储结果图和计量计费的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
StoreUri	String	是	`imagex-common/b9***77`	待扩展图片的存储 URI 或访问 URL（公网可访问）。您可在控制台资源管理获取图片的存储 URI 以及访问 URL。
Model	Integer	是	`0`	扩展模型，取值如下所示： `0`：国漫风格模型； `1`：通用模型。
Top	Float	否	`0.15`	向上扩展比例，取值范围为 [0, 0.4]。
Bottom	Float	否	`0.15`	向下扩展比例，取值范围为 [0, 0.4]。
Left	Float	否	`0.15`	向左扩展比例，取值范围为 [0, 0.4]。
Right	Float	否	`0.15`	向右扩展比例，取值范围为 [0, 0.4]。

返回参数

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

参数	类型	示例值	描述
ResUri	String	`tos-cn-i-ln*tb/97*e9`	结果图 URI。您可使用结果图 URI（即 `ResUri`）拼接完整访问 URL 后，在浏览器查看图像扩展效果。

请求示例

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

返回示例

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

错误码

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

服务端 SDK

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

历史版本

2018-08-01 版本 GetImageBgFillResult 接口文档现已停止维护，建议您参考本文档使用最新版本。