文档中心

添加常用图片/背景/蒙版要素

最近更新时间：2024.01.31 15:20:01

首次发布时间：2022.07.20 10:05:48

在要素列表添加常用的图片、背景或蒙版等要素，如果添加失败将返回失败的要素 URI。

请求说明

接口名称：AddImageElements
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=AddImageElements&Version=2018-08-01
请求频率限制：5 次/秒
超时时间：10 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 openAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。

Body

参数	类型	是否必选	描述
Type	String	是	要素类型，取值如下所示： image：图片要素； background：背景要素； mask：蒙版要素。
Images	Array of String	是	待添加的图片 URI 列表。

参数

类型

是否必选

描述

Type

String

是

要素类型，取值如下所示：

image：图片要素；
background：背景要素；
mask：蒙版要素。

Images

Array of String

是

待添加的图片 URI 列表。

返回参数

参数	类型	描述
FailedList	Array of String	添加失败的图片 URI 列表。若全部添加失败，则接口将返回失败。

示例

请求示例

POST https://imagex.volcengineapi.com?Action=AddImageElements&Version=2018-08-01
{
   "Type":"background",
   "Images":[
      "tos-cn-i-nn***mq/mofang/20220629-111409.jpeg"
   ]
}

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"2022071513305401021204519717A8DFCF",
      "Action":"AddImageElements",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
   "FailedList":[    
      ]
   }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202207181437480102121020921AF04658",
        "Action": "AddImageElements",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
             "Code": "xx",
            "Message": "xx"
        }
    }
}

错误码

访问公共错误码和创意魔方错误码获取详细信息。