文档中心

使用漫画风获取结果图

最近更新时间：2024.04.26 11:06:58

首次发布时间：2024.04.26 11:06:58

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

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 20 秒。
前提条件：已开通漫画风组件能力。
计费说明：漫画风功能属于增值服务项，故使用后会产生增值服务费用，当前支持后付费的计费方式，具体请参见增值服务。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

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

参数	类型	是否必选	示例值	描述
ServiceId	String	是	`fc**cf`	待漫画风处理图片对应的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
StoreUri	String	是	`tos-i-hrpr/9122.jpeg`	待处理图片的存储 URI 或访问 URL（可公网访问）。您可在控制台资源管理获取图片的存储 URI 以及访问 URL。

ServiceId

String

是

fc**cf

待漫画风处理图片对应的服务 ID。

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

StoreUri String 是 tos-i-hr**pr/91**22.jpeg 待处理图片的存储 URI 或访问 URL（可公网访问）。您可在控制台资源管理获取图片的存储 URI 以及访问 URL。

返回参数

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

参数	类型	示例值	描述
ResUri	String	`tos-i-fccf/2173.jpeg`	结果图 URI。您可使用结果图 URI（即 `ResUri`）拼接完整访问 URL 后，在浏览器查看图像漫画风效果。

请求示例

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

返回示例

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

错误码

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

服务端 SDK

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