Doubao · 查询素材组

通过素材组 ID 获取名称、描述、类型、所属项目和时间信息。

POSThttps://app.ai.kedang.net/ark?Action=GetAssetGroup&Version=2024-01-01

豆包素材库 · Ark Action API

素材库使用流程 · 官方参数参考 ↗

查看响应字段说明
查询素材组响应字段
字段类型说明
ResponseMetadataobject请求元信息。
ResponseMetadata.RequestIdstring请求标识,可用于定位一次接口请求。错误响应中可能省略。
ResponseMetadata.Actionstring本次请求的动作名称。
ResponseMetadata.Versionstring本次请求的接口版本。错误响应中可能省略。
ResponseMetadata.Servicestring服务名称,示例为 ark。
ResponseMetadata.Regionstring服务地域,示例为 cn-beijing。
ResponseMetadata.Errorobject|null请求级业务错误;非空表示本次操作失败,HTTP 状态可能仍为 200。错误响应可能没有 Result。
ResponseMetadata.Error.CodeNinteger|null兼容错误编号,可为 null 或省略;错误判断与排查优先使用 Code。
ResponseMetadata.Error.Codestring请求级错误码,例如 ResourceNotFound 表示指定素材不存在。
ResponseMetadata.Error.Messagestring请求级错误说明,和 Code 一起读取。
Resultobject动作的返回结果;各动作的字段见下文。
Result.CreateTimestring素材组的创建时间。
Result.Descriptionstring素材组的描述,最长 300 个字符。
Result.GroupTypestring素材组类型:AIGC 为虚拟人像,LivenessFace 为真人素材。查询可能返回两种类型;本页创建接口仅支持 AIGC。
Result.Idstring素材组 ID。完整复制接口返回的 ID,不要自行添加前缀。
Result.Namestring素材组名称,最长 64 个字符。
Result.ProjectNamestring素材组所属的项目名称。
Result.UpdateTimestring素材组的更新时间。

Headers请求头

左右滑动查看完整参数表

请求头
参数名类型必填说明默认值 / 示例
Authorizationstring必填

可当平台的 API Key,请替换示例中的密钥占位值。

示例
sk-YOUR_API_KEY
Content-Typestring必填

请求体使用 JSON 格式。

示例
application/json

Query Parameters查询参数

左右滑动查看完整参数表

查询参数
参数名类型必填说明默认值 / 示例
Actionstring必填

需要执行的素材库管理动作。

示例
GetAssetGroup
Versionstring必填

素材库管理接口的固定版本号。

示例
2024-01-01

Request Body请求体

application/json

左右滑动查看完整参数表

请求体
参数名类型必填说明默认值 / 示例
Idstring必填

需要查询的素材组 ID,可从对应的创建接口或列表接口获取。完整复制接口返回的 ID,不要自行添加前缀。

示例
YOUR_GROUP_ID
ProjectNamestring可选

资源所属的项目名称,默认使用 default;资源位于其他项目时,应填写该项目的名称。

默认值
default
示例
default

使用说明

  • 先检查 HTTP 状态,再检查 ResponseMetadata.Error;即使 HTTP 200,该字段非空也表示本次请求失败。请求级错误与 Result.Error 中的素材处理错误分别判断。
  • 查询时填写素材组所属项目;使用错误的项目名称可能无法获取目标素材组。
  • 返回类型可能为虚拟人像或真人素材,这不改变本页创建接口仅支持虚拟人像素材组的范围。