You need to enable JavaScript to run this app.
导航
使用智能图像扩展获取结果图
最近更新时间:2024.08.05 18:26:08首次发布时间:2021.11.29 19:44:20

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

说明

该接口属于历史版本 API,建议您使用新版 GetImageBgFillResult 接口。

使用说明

请在扩展前确保您的原图满足扩展限制说明

注意事项

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

请求说明

  • 请求方式:POST
  • 请求地址:https://imagex.volcengineapi.com/?Action=GetImageBgFillResult&Version=2018-08-01

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetImageBgFillResult接口名称。当前 API 的名称为 GetImageBgFillResult
VersionString2018-08-01接口版本。当前 API 的版本为 2018-08-01

Body

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

ServiceId

String

ln***tb

服务ID

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息
StoreUriStringimagex-common/b9***77待填充原图的存储 URI 和 URL(公网可访问的 URL)。

Model

Integer

0

填充模型,取值如下所示:

  • 0:国漫风格模型,适用于漫画风格图片
  • 1:通用模型,适用于风景图
TopFloat0.15向上填充比例,取值范围为 [0, 0.4]。
BottomFloat0.15向下填充比例,取值范围为 [0, 0.4]。
LeftFloat0.15向左填充比例,取值范围为 [0, 0.4]。
RightFloat0.15向右填充比例,取值范围为 [0, 0.4]。

返回参数

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

参数类型示例值描述
ResUriStringtos-cn-i-ln***tb/97***e9填充结果图的 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"
  }
}

错误码

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

服务端 SDK

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