文档中心

使用智能裁剪获取结果图

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

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

本接口支持指定服务 ID 以及原图地址，经智能裁剪后得到处理后的图片 URI。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ServiceId	String	是	`test`	待处理图片对应的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
StoreUri	String	是	`bkt/uri`	待处理原图的存储 URI 或访问 URL（公网可访问的 URL）。您可在控制台资源管理获取图片的存储 URI 以及访问 URL。
Scene	String	否	`cartoon`	裁剪场景，取值如下所示： `normal`：（默认）普通人脸裁剪； `cartoon`：动漫人脸裁剪。说明当前仅支持对图片内人脸智能裁剪，其他裁剪能力在持续开放中，敬请期待。
Policy	String	否	`top`	降级策略，即因未识别到图片内人脸而裁剪失败时，需要对原图执行的其他处理操作。取值如下所示： `center`：（默认）居中裁剪，默认裁剪中间图片。 `top`：居上裁剪，默认裁剪上方图片。 `fglass`：高斯模糊，将按设置宽高自动适配图片，结果图多出原图部分以原图背景高斯模糊效果填充。
Sigma	Float	否	`1`	当`Policy`取值为`fglass`时，配置有效。高斯模糊参数，取值为大于 0 的整数，值越大越模糊。
Width	Integer	否	`100`	图片裁剪后的宽度设置，单位为 px。当图片小于设置的宽高时，将不被裁剪。
Height	Integer	否	`100`	图片裁剪后的高度设置，单位为 px。当图片小于设置的宽高时，将不被裁剪。

返回参数

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

参数类型示例值描述

ResUri String tos-cn-i-s7**6t/6a***f2 结果图 URI。您可使用结果图 URI（即 ResUri）拼接完整访问 URL 后，在浏览器查看裁剪效果。

参数	类型	示例值	描述
ResUri	String	`tos-cn-i-s76t/6a*f2`	结果图 URI。您可使用结果图 URI（即 `ResUri`）拼接完整访问 URL 后，在浏览器查看裁剪效果。
Demotioned	Boolean	`true`	结果图是否降级，取值如下所示： `true`：降级 `flase`：未降级

Demotioned

Boolean

true

结果图是否降级，取值如下所示：

true：降级
flase：未降级

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageSmartCropResult&Version=2023-05-01
{
  "ServiceId": "test",
  "StoreUri": "bkt/uri",
  "Width": 100,
  "Height": 100
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202205241533440101510510472098B54C",
        "Action": "GetImageSmartCropResult",
        "Version": "2023-05-01",
		    "Service": "imagex",
	   	  "Region": "cn-north-1"
    },
    "Result": {
        "ResUri": "tos-cn-i-s7**6t/6a***f2",
        "Demotioned": true
    }
}

错误码

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

服务端 SDK

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