XRToken API 文档

获取素材分组列表

API 配置
保存后下方「Try It」面板会自动携带此 API Key 发送真实请求。
Base: api.xrtoken.net

列出当前用户的所有素材分组,支持分页和按名称筛选。

GET
/v1/asset-groups

Authorization

BearerAuth
AuthorizationBearer <token>

API 密钥认证(OpenAI 格式)。在 Authorization 请求头中传入:

Authorization: Bearer tr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Query Parameters

page_num?integer

页码,从 1 开始

Default1
Range1 <= value
page_size?integer

每页数量,最大 100

Default10
Range1 <= value <= 100
name?string

按分组名称筛选(模糊匹配)

type?string

分组类型. aigc (默认) 返回 AIGC 素材组; real_person 返回 validate-session 流程产生的真人 (LivenessFace) 组. 上游火山 Ark 只接受单一类型, 没有"返所有"这一档, 需要两种都看时请分两次调用.

Default"aigc"
Value in"aigc" | "real_person"
external_user_id?string

第三方 SaaS end-user 标识符 (可选). 设了之后只返回绑到 (api_user, external_user_id) 的 group; 不传 (或留空) 只返回直接绑到 API key 持有者的 group (老行为). 最大 128 字符.

Lengthlength <= 128

Response Body

application/json

application/json

application/json

curl -X get "https://api.xrtoken.net/v1/asset-groups?external_user_id=end-user-42"
{
  "Items": [
    {
      "Id": "string",
      "Name": "string",
      "Description": "string",
      "GroupType": "AIGC",
      "CreateTime": "string",
      "UpdateTime": "string"
    }
  ],
  "TotalCount": 0,
  "PageNumber": 0,
  "PageSize": 0
}
{
  "error": "invalid or missing API key",
  "type": "auth_error"
}
{
  "error": "rate limit exceeded",
  "type": "rate_limit_error"
}