使用画质增强获取结果图--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

使用画质增强获取结果图

最近更新时间：2024.06.03 17:37:37首次发布时间：2021.11.29 19:44:20

本接口支持指定服务 ID、原图地址和画质增强模型，提升原图画质后获取结果图 URI。

说明

您也可以通过调用 GetImageEnhanceResultWithData 输入图片二进制数据，来获取经画质增强能力编码后的图片二进制数据。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

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

Body

参数	类型	是否必选	示例值	描述
ServiceId	String	是	`v0***bf`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
StoreUri	String	是	`test.webp`	待增强的原图地址的存储 URI 和 URL（公网可访问的 URL）。
Model	Integer	是	`0`	增强模型，取值如下所示： `0`：通用模型 `1`：低质专清模型
DisableAr	Boolean	否	`false`	是否不去压缩失真。`Model`取值为`0`时选填，支持以下取值： `true`：不进行去压缩失真处理 `false`：（默认）进行去压缩失真处理
DisableSharp	Boolean	否	`true`	是否不自适应锐化。`Model`取值为`0`时选填，支持以下取值： `true`：不进行锐化处理 `false`：（默认）进行锐化处理

返回参数

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

参数	类型	示例值	描述
ResUri	String	`tos-i-v0***bf/a957dcc7cb89b0a4e2889466f2fdc9d7`	增强图像的 URI。您可使用结果图 URI（即 `ResUri`）拼接完整访问 URL 后，在浏览器查看增强效果。
Method	String	`ar,sharp`	实际执行的增强方法。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageEnhanceResult&Version=2018-08-01

{
  "ServiceId": "v0***bf",
  "StoreUri": "test.webp",
  "Model": 0,
  "DisableSharp": true,
  "DisableAr": false
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2022052415234901022524314707965A79",
    "Action": "GetImageEnhanceResult",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "ResUri": "tos-i-v0***bf/a957dcc7cb89b0a4e2889466f2fdc9d7",
    "Method": "ar,sharp"
  }
}

错误码

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

服务端 SDK

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