最近更新时间:2023.05.19 15:49:37
首次发布时间:2022.09.26 10:11:02
本接口支持指定服务 ID 以及原图地址,经智能裁剪后得到处理后的图片 URI。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称。 |
Version | String | 是 | 接口版本。veImageX 当前API 的版本为2018-08-01 。 |
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
ServiceId | String | 是 | 服务 ID。 |
StoreUri | String | 是 | 待处理原图的存储 URI 和 URL(公网可访问的 URL)。 |
Policy | String | 否 | 降级策略,即当智能裁剪失败时的操作,默认居中裁剪。
|
Scene | String | 否 | 裁剪场景 (normal,cartoon),默认普通人脸裁剪。支持取值如下:
说明 当前仅支持了智能人脸裁剪能力,其他裁剪能力在持续开放中,敬请期待。 |
Sigma | Float | 否 | 当Policy 取值为fglass 时的高斯模糊参数,取值为大于 0 的整数,值越大越模糊。 |
Width | Int | 否 | 图片裁剪后的宽度设置,单位为 px。当图片小于设置的宽高时,将不被裁剪。 |
Height | Int | 否 | 图片裁剪后的高度设置,单位为 px。当图片小于设置的宽高时,将不被裁剪。 |
参数 | 类型 | 描述 |
---|---|---|
ResUri | String | 结果图存储 URI。 |
Demotioned | bool | 是否降级。支持取值如下:
|
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": "" } } }
为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: