Doubao · 查询素材组列表
按类型、素材组 ID 或名称筛选素材组,并使用凭证或页码分页。
POST
https://app.ai.kedang.net/ark?Action=ListAssetGroups&Version=2024-01-01查看响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
ResponseMetadata | object | 请求元信息。 |
ResponseMetadata.RequestId | string | 请求标识,可用于定位一次接口请求。错误响应中可能省略。 |
ResponseMetadata.Action | string | 本次请求的动作名称。 |
ResponseMetadata.Version | string | 本次请求的接口版本。错误响应中可能省略。 |
ResponseMetadata.Service | string | 服务名称,示例为 ark。 |
ResponseMetadata.Region | string | 服务地域,示例为 cn-beijing。 |
ResponseMetadata.Error | object|null | 请求级业务错误;非空表示本次操作失败,HTTP 状态可能仍为 200。错误响应可能没有 Result。 |
ResponseMetadata.Error.CodeN | integer|null | 兼容错误编号,可为 null 或省略;错误判断与排查优先使用 Code。 |
ResponseMetadata.Error.Code | string | 请求级错误码,例如 ResourceNotFound 表示指定素材不存在。 |
ResponseMetadata.Error.Message | string | 请求级错误说明,和 Code 一起读取。 |
Result | object | 动作的返回结果;各动作的字段见下文。 |
Result.Items | array<object> | 符合筛选条件的素材组列表;没有匹配结果时为空数组。 |
Result.Items[].CreateTime | string | 素材组的创建时间。 |
Result.Items[].Description | string | 素材组的描述,最长 300 个字符。 |
Result.Items[].GroupType | string | 素材组类型:AIGC 为虚拟人像,LivenessFace 为真人素材。查询可能返回两种类型;本页创建接口仅支持 AIGC。 |
Result.Items[].Id | string | 素材组 ID。完整复制接口返回的 ID,不要自行添加前缀。 |
Result.Items[].Name | string | 素材组名称,最长 64 个字符。 |
Result.Items[].ProjectName | string | 素材组所属的项目名称。 |
Result.Items[].UpdateTime | string | 素材组的更新时间。 |
Result.NextToken | string | 仅在凭证分页且还有下一页时返回的翻页凭证;下次请求应原样传入,未返回表示遍历结束。 |
Result.PageNumber | integer | 当前页码,仅在页码分页时返回。 |
Result.PageSize | integer | 每页记录数,范围为 1 至 100,仅在页码分页时返回。 |
Result.TotalCount | integer | 符合筛选条件的记录总数,仅在页码分页时返回。 |
Headers请求头
左右滑动查看完整参数表
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 |
|---|---|---|---|---|
Authorization | string | 必填 | 可当平台的 API Key,请替换示例中的密钥占位值。 | |
Content-Type | string | 必填 | 请求体使用 JSON 格式。 |
Query Parameters查询参数
左右滑动查看完整参数表
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 |
|---|---|---|---|---|
Action | string | 必填 | 需要执行的素材库管理动作。 | |
Version | string | 必填 | 素材库管理接口的固定版本号。 |
Request Body请求体
application/json左右滑动查看完整参数表
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filter | object | 必填 | 查询过滤条件。 | — | ||||||||||||||||||||
| ||||||||||||||||||||||||
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 |
|---|---|---|---|---|
GroupType | string | 必填 | 待查询的素材组类型,AIGC 表示虚拟人像,LivenessFace 表示真人素材;该查询枚举不代表创建接口支持真人素材组。 可选值 AIGCLivenessFace | |
GroupIds | array<string> | 可选 | 按素材组 ID 列表筛选;可从创建素材组接口或素材组列表获取 ID。完整复制接口返回的 ID,不要自行添加前缀。 | |
Name | string | 可选 | 按完整名称筛选,最长 64 个字符;不要依赖名称前缀或片段匹配。 |
NextToken凭证分页的翻页凭证;首次查询不填写,后续查询原样填写前次响应中的值。与 PageNumber、PageSize 互斥。
MaxResults凭证分页每页最多返回的记录数,范围为 1 至 100,默认 10;与 PageNumber、PageSize 互斥。
SortBy排序字段,默认按创建时间排序。
可选值
CreateTimeUpdateTimeSortOrder排序方向,Desc 为降序,Asc 为升序,默认降序。
可选值
DescAscProjectName资源所属的项目名称,默认使用 default;资源位于其他项目时,应填写该项目的名称。
PageNumber页码从 1 开始,须与 PageSize 同时使用,且与 NextToken、MaxResults 互斥;PageSize × PageNumber 大于 10000 时应改用凭证分页。
PageSize页码分页每页记录数,范围为 1 至 100;须与 PageNumber 同时使用,且与 NextToken、MaxResults 互斥;PageSize × PageNumber 大于 10000 时应改用凭证分页。
使用说明
- 先检查 HTTP 状态,再检查 ResponseMetadata.Error;即使 HTTP 200,该字段非空也表示本次请求失败。请求级错误与 Result.Error 中的素材处理错误分别判断。
- 推荐使用 NextToken 和 MaxResults 进行凭证分页;首次查询省略 NextToken,有下一页时使用响应中的凭证继续查询。
- 凭证分页与页码分页互斥:NextToken、MaxResults 不能与 PageNumber、PageSize 混用;页码分页的 PageNumber、PageSize 必须同时提供。
- 未提供分页参数时默认采用凭证分页,MaxResults 为 10;后续提供 NextToken 时若省略 MaxResults,仍按 10 查询。每页记录数范围为 1 至 100。
- 凭证分页不返回 TotalCount、PageNumber、PageSize;页码分页会返回这三个字段。未返回 NextToken 表示遍历结束,本页响应模板展示已到最后一页的情况。
- 后续查询应保持 Filter、ProjectName、SortBy、SortOrder 与首次查询一致;空凭证、被改写的凭证或跨接口、账号、项目复用的凭证无效。
- 当 PageSize × PageNumber 大于 10000 时,改用 NextToken 实现深翻页。
- Filter.GroupType 为必填筛选条件;AIGC 与 LivenessFace 是查询类型,本页的创建动作仅面向虚拟人像素材组。
- Name 筛选请填写完整名称;名称片段不保证匹配。Items 为空只表示当前筛选没有匹配资源,不代表素材不存在。