XRToken API 文档

获取素材列表

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

列出当前用户拥有的素材,支持按分组、名称、状态筛选。

GET
/v1/assets

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
group_id?string

按指定分组 ID 筛选(必须是当前用户拥有的分组)

type?string

分组类型, 上游火山 Ark 必填项. aigc (默认) 查 AIGC 素材组; real_person 查 validate-session 流程产生的真人 (LivenessFace) 组. 即使传了 group_id 也要配对正确的 type: 查真人组的素材必须传 type=real_person, 否则按默认 aigc 过滤会返回空列表。上游只接受单一类型, 没有"返所有"这一档。

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

按素材名称筛选(模糊匹配)

statuses?string

按状态筛选:ActiveProcessingFailed

Value in"Active" | "Processing" | "Failed"

Response Body

application/json

application/json

application/json

application/json

curl -X get "https://api.xrtoken.net/v1/assets"
{
  "Items": [
    {
      "Id": "string",
      "Name": "string",
      "AssetType": "Image",
      "Status": "Active",
      "GroupId": "string",
      "URL": "string",
      "CreateTime": "string",
      "UpdateTime": "string",
      "Error": {
        "Code": "string",
        "Message": "string"
      }
    }
  ],
  "TotalCount": 0,
  "PageNumber": 0,
  "PageSize": 0
}
{
  "error": "invalid or missing API key",
  "type": "auth_error"
}
{
  "error": "string",
  "type": "invalid_request_error"
}
{
  "error": "rate limit exceeded",
  "type": "rate_limit_error"
}