文档中心

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

最近更新时间：2024.04.19 11:39:02

首次发布时间：2024.04.19 11:39:02

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

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 openAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

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

参数	类型	是否必选	示例值	描述
Type	String	是	`background`	要素类型，取值如下所示： `image`：图片要素 `background`：背景要素 `mask`：蒙版要素
Images	Array of String	是	`["tos-cn-i-nn***mq/mofang/20220629-111409.jpeg"]`	待添加的图片存储 URI 列表。说明添加的`Images`要素文件的所属账号需要与开通创意魔方的所属账号属于同一个火山引擎账号。否则，将无法添加成功。

Type

String

是

background

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

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

Images

Array of String

是

["tos-cn-i-nn***mq/mofang/20220629-111409.jpeg"]

待添加的图片存储 URI 列表。

说明

添加的Images要素文件的所属账号需要与开通创意魔方的所属账号属于同一个火山引擎账号。否则，将无法添加成功。

返回参数

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

参数	类型	示例值	描述
FailedList	Array of String	`["tos-cn-i-nn***mq/mofang/20220629-111409.jpeg"]`	添加失败的图片 URI 列表。若全部添加失败，则接口将返回失败。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "AddImageElements",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailedList": ["tos-cn-i-nn***mq/mofang/20220629-111409.jpeg"]
    }
}

错误码

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