POST 方法,请求地址格式如下:{BASE_URL}/api/v1/{Action}?Action={Action}&Version=2024-01-01POST {BASE_URL}/api/v1/CreateAssetGroup?Action=CreateAssetGroup&Version=2024-01-01| 参数 | 类型 | 必选 | 说明 |
|---|---|---|---|
Action | string | 是 | 必须与路径中的接口名称完全一致,区分大小写。例如调用 /CreateAsset 时必须传 Action=CreateAsset。 |
Version | string | 是 | 固定为 2024-01-01。 |
AssetLibrary.InvalidRequest。| 请求头 | 必选 | 说明 |
|---|---|---|
Authorization | 是 | Bearer API_KEY,其中 API_KEY 为平台签发的访问令牌。 |
Content-Type | 是 | 固定为 application/json。 |
{
"ResponseMetadata": {
"RequestId": "20260328000000000000000000000000",
"Action": "CreateAssetGroup",
"Version": "2024-01-01",
"Service": "ark",
"Region": "cn-beijing"
},
"Result": {}
}| 字段 | 说明 |
|---|---|
ResponseMetadata.RequestId | 请求追踪 ID,排查问题时请一并提供。 |
ResponseMetadata.Action | 当前接口动作。 |
ResponseMetadata.Version | 素材渠道协议版本。 |
ResponseMetadata.Service | 素材渠道服务名称。 |
ResponseMetadata.Region | 素材渠道区域。 |
ResponseMetadata.Error | 业务失败时出现,包含 Code 和 Message。 |
Result | 业务结果;业务失败时为空对象 {}。 |
200。调用方必须检查 ResponseMetadata.Error 是否存在,不能只依赖 HTTP 状态码判断业务是否成功。鉴权失败、网关异常或网络故障仍 可能返回非 200 状态或非 JSON 响应。ProjectName 不传时使用当前素材渠道配置的默认项目,通常为 default;最大长度为 64 个字符。Result.Id 是本系统素材库业务 ID。后续查询、更新、删除及筛选必须使用该 ID,不要改用上游渠道 ID。ProjectName 必须与所属素材组的项目一致。| 分类 | Action | 请求路径 |
|---|---|---|
| 素材 | CreateAsset | /api/v1/CreateAsset |
| 素材 | GetAsset | /api/v1/GetAsset |
| 素材 | UpdateAsset | /api/v1/UpdateAsset |
| 素材 | DeleteAsset | /api/v1/DeleteAsset |
| 素材 | ListAssets | /api/v1/ListAssets |
| 素材组 | CreateAssetGroup | /api/v1/CreateAssetGroup |
| 素材组 | GetAssetGroup | /api/v1/GetAssetGroup |
| 素材组 | UpdateAssetGroup | /api/v1/UpdateAssetGroup |
| 素材组 | DeleteAssetGroup | /api/v1/DeleteAssetGroup |
| 素材组 | ListAssetGroups | /api/v1/ListAssetGroups |
GetAsset 或 ListAssets 查询后续状态。POST /api/v1/CreateAsset?Action=CreateAsset&Version=2024-01-01| 字段 | 类型 | 必选 | 说明 |
|---|---|---|---|
GroupId | string | 是 | 所属素材组的业务 ID。 |
URL | string | 是 | 公网可访问的绝对 HTTP/HTTPS 地址,最长 8192 字节;不支持 Base64。 |
Name | string | 是 | 素材名称,最多 64 个字符,可用于列表模糊搜索。 |
AssetType | string | 是 | Image、Video 或 Audio。 |
ProjectName | string | 否 | 项目名称,默认使用当前渠道的默认项目。 |
jpeg、png、webp、bmp、tiff、gif、heic、heif;宽高比 (0.4, 2.5);宽、高均在 (300, 6000) px;小于 30 MB。mp4、mov;480p 或 720p;时长 [2, 15] 秒;宽高比 [0.4, 2.5];宽、高均在 [300, 6000] px;总像素数 [409600, 927408];不超过 50 MB;帧率 [24, 60] FPS。wav、mp3;时长 [2, 15] 秒;不超过 15 MB。| 字段 | 类型 | 说明 |
|---|---|---|
Result.Id | string | 新建素材的业务 ID。 |
{
"ResponseMetadata": {
"RequestId": "20260328000000000000000000000000",
"Action": "CreateAsset",
"Version": "2024-01-01",
"Service": "ark",
"Region": "cn-beijing"
},
"Result": {
"Id": "asset-20260328000000000-def34"
}
}POST /api/v1/GetAsset?Action=GetAsset&Version=2024-01-01| 字段 | 类型 | 必选 | 说明 |
|---|---|---|---|
Id | string | 是 | 素材业务 ID。 |
ProjectName | string | 否 | 素材所属项目,默认使用当前渠道的默认项目。 |
{
"Id": "asset-20260328000000000-def34",
"ProjectName": "default"
}| 字段 | 类型 | 说明 |
|---|---|---|
Id | string | 素材业务 ID。 |
GroupId | string | 所属素材组业务 ID。 |
Name | string | 素材名称。 |
URL | string | 素材访问地址;渠道返回临时地址时应及时使用或保存。 |
AssetType | string | Image、Video 或 Audio。 |
Status | string | Pending、Uploading、Processing、Ready 或 Failed。 |
Error | object | 处理失败信息,存在时包含 Code 和 Message。 |
Moderation | object | 内容审核信息,存在时包含 Strategy。 |
LastInferenceTime | string | 最近推理时间,无数据时为空字符串。 |
ProjectName | string | 项目名称。 |
CreateTime | string | RFC 3339 格式的创建时间。 |
UpdateTime | string | RFC 3339 格式的更新时间。 |
{
"ResponseMetadata": {
"RequestId": "20260328000000000000000000000000",
"Action": "GetAsset",
"Version": "2024-01-01",
"Service": "ark",
"Region": "cn-beijing"
},
"Result": {
"Id": "asset-20260328000000000-def34",
"GroupId": "group-20260328000000000-abc12",
"Name": "avatar",
"URL": "https://example.com/avatar.png",
"AssetType": "Image",
"Status": "Ready",
"LastInferenceTime": "",
"ProjectName": "default",
"CreateTime": "2026-03-28T00:00:00Z",
"UpdateTime": "2026-03-28T00:00:00Z"
}
}POST /api/v1/UpdateAsset?Action=UpdateAsset&Version=2024-01-01| 字段 | 类型 | 必选 | 说明 |
|---|---|---|---|
Id | string | 是 | 素材业务 ID。 |
Name | string | 是 | 新名称,最多 64 个字符。 |
ProjectName | string | 否 | 素材所属项目,默认使用当前渠道的默认项目。 |
{
"Id": "asset-20260328000000000-def34",
"Name": "new-avatar-name",
"ProjectName": "default"
}{
"ResponseMetadata": {
"RequestId": "20260328000000000000000000000000",
"Action": "UpdateAsset",
"Version": "2024-01-01",
"Service": "ark",
"Region": "cn-beijing"
},
"Result": {
"Id": "asset-20260328000000000-def34"
}
}POST /api/v1/DeleteAsset?Action=DeleteAsset&Version=2024-01-01| 字段 | 类型 | 必选 | 说明 |
|---|---|---|---|
Id | string | 是 | 素材业务 ID。 |
ProjectName | string | 否 | 素材所属项目,默认使用当前渠道的默认项目。 |
{
"Id": "asset-20260328000000000-def34",
"ProjectName": "default"
}{
"ResponseMetadata": {
"RequestId": "20260328000000000000000000000000",
"Action": "DeleteAsset",
"Version": "2024-01-01",
"Service": "ark",
"Region": "cn-beijing"
},
"Result": {}
}POST /api/v1/ListAssets?Action=ListAssets&Version=2024-01-01| 字段 | 类型 | 必选 | 说明 |
|---|---|---|---|
Filter | object | 否 | 筛选条件。 |
Filter.GroupIds | string[] | 否 | 所属素材组业务 ID 列表。 |
Filter.GroupType | string | 否 | 素材组类型,当前为 AIGC。 |
Filter.Statuses | string[] | 否 | 状态列表:Pending、Uploading、Processing、Ready、Failed。 |
Filter.Name | string | 否 | 素材名称,模糊匹配。 |
PageNumber | integer | 是 | 页码,从 1 开始。 |
PageSize | integer | 是 | 每页数量,范围为 1~100。 |
SortBy | string | 否 | CreateTime、UpdateTime 或 GroupId,默认为 CreateTime。 |
SortOrder | string | 否 | Asc 或 Desc,默认为 Desc。 |
ProjectName | string | 否 | 项目名称,默认使用当前渠道的默认项目。 |
{
"Filter": {
"GroupIds": ["group-20260328000000000-abc12"],
"GroupType": "AIGC",
"Statuses": ["Ready"],
"Name": "avatar"
},
"PageNumber": 1,
"PageSize": 10,
"SortBy": "CreateTime",
"SortOrder": "Desc",
"ProjectName": "default"
}| 字段 | 类型 | 说明 |
|---|---|---|
Items | object[] | 素材列表,字段与 GetAsset 的 Result 一致。 |
TotalCount | integer | 符合条件的素材总数。 |
PageNumber | integer | 当前页码。 |
PageSize | integer | 当前每页数量。 |
{
"ResponseMetadata": {
"RequestId": "20260328000000000000000000000000",
"Action": "ListAssets",
"Version": "2024-01-01",
"Service": "ark",
"Region": "cn-beijing"
},
"Result": {
"Items": [
{
"Id": "asset-20260328000000000-def34",
"GroupId": "group-20260328000000000-abc12",
"Name": "avatar",
"URL": "https://example.com/avatar.png",
"AssetType": "Image",
"Status": "Ready",
"LastInferenceTime": "",
"ProjectName": "default",
"CreateTime": "2026-03-28T00:00:00Z",
"UpdateTime": "2026-03-28T00:00:00Z"
}
],
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 10
}
}POST /api/v1/CreateAssetGroup?Action=CreateAssetGroup&Version=2024-01-01| 字段 | 类型 | 必选 | 说明 |
|---|---|---|---|
Name | string | 是 | 素材组名称,最多 64 个字符。 |
Description | string | 否 | 素材组描述,最多 300 个字符。 |
GroupType | string |