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

使用智能裁剪获取结果图

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

首次发布时间2022.09.26 10:11:02

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

请求说明

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

Policy

String

降级策略,即当智能裁剪失败时的操作,默认居中裁剪。
支持取值如下:

  • center:居中裁剪,默认裁剪中间图片;
  • top:居上裁剪,默认裁剪上方图片;
  • fglass:高斯模糊,将按设置宽高自动适配图片,结果图多出原图部分以原图背景高斯模糊效果填充。

Scene

String

裁剪场景 (normal,cartoon),默认普通人脸裁剪。支持取值如下:

  • normal:普通人脸裁剪;
  • cartoon:动漫人脸裁剪。

说明

当前仅支持了智能人脸裁剪能力,其他裁剪能力在持续开放中,敬请期待。

SigmaFloatPolicy取值为fglass时的高斯模糊参数,取值为大于 0 的整数,值越大越模糊。
WidthInt图片裁剪后的宽度设置,单位为 px。当图片小于设置的宽高时,将不被裁剪。
HeightInt图片裁剪后的高度设置,单位为 px。当图片小于设置的宽高时,将不被裁剪。

返回参数

参数类型描述
ResUriString结果图存储 URI。

Demotioned

bool

是否降级。支持取值如下:

  • true:降级;
  • flase:未降级。

示例

请求示例

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

正常返回示例

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

异常返回示例

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

错误码

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

服务端 SDK

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