使用漫画风获取结果图

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

首次发布时间：2022.10.12 11:42:27

通过指定服务 ID 以及待处理图片，获取漫画风处理后结果图地址。

请求说明

接口名称：GetImageComicResult
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=GetImageComicResult&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）。

参数

类型

是否必填

描述

ServiceId

String

是

服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

StoreUri

String

是

待处理原图的存储 URI 和 URL（可公网访问的 URL）。

返回参数

参数	类型	描述
ResUri	string	结果图像存储 URI。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageComicResult&Version=2018-08-01
{
			"ServiceId": "fc**cf",
			"StoreUri": "tos-i-hr**pr/91**22.jpeg"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetImageComicResult",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "ResUri": "tos-i-fc**cf/21**73.jpeg"
    }
}

异常返回示例

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

错误码

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

服务端 SDK

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