You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

使用画质增强获取结果图

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

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

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

说明

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

请求说明

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

说明

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

请求参数

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

Query

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

Body

参数类型是否必填描述

ServiceId

String

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息
StoreUriString待增强的原图地址的存储 URI 和 URL(公网可访问的 URL)。

Model

Integer

增强模型,取值如下所示:

  • 0:通用模型
  • 1:低质专清模型

DisableAr

Bool

是否不去压缩失真。Model取值为0时选填,支持以下取值:

  • true:不进行去压缩失真处理
  • false:(默认)进行去压缩失真处理

DisableSharp

Bool

是否不自适应锐化。Model取值为0时选填,支持以下取值:

  • true:不进行锐化处理
  • false:(默认)进行锐化处理

返回参数

参数类型描述
ResUriString增强图像的 URI。
MethodString实际执行的增强方法。

示例

请求示例

POST https://imagex.volcengineapi.com?Action=GetImageEnhanceResult&ServiceId=example&Version=2018-08-01
{
    "ServiceId": "v0***bf",
    "StoreUri": "test.webp",
    "Model": 0
}

正常返回示例

{
    "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"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022052415272701022524315306968BA4",
        "Action": "GetImageEnhanceResult",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": ,
            "Code": "",
            "Message": "参数"
        }
    }
}

错误码

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

服务端 SDK

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