XRToken API Docs

List assets

API Configuration
After saving, the Try It panel below sends real requests with this key.
Base: api.xrtoken.ai

List assets owned by the current user with filtering by group, name, and status.

GET
/v1/assets

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication (OpenAI format). Pass in the Authorization header:

Authorization: Bearer tr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Query Parameters

page_num?integer

Page number, starting from 1

Default1
Range1 <= value
page_size?integer

Items per page, maximum 100

Default10
Range1 <= value <= 100
group_id?string

Filter by group ID (must be a group owned by the current user)

type?string

Group type, required by upstream Volcengine Ark. aigc (default) lists AIGC asset groups; real_person lists liveness (LivenessFace) groups created via the validate-session flow. You must pass the matching type even when group_id is set: to list a real-person group's assets, pass type=real_person, otherwise the default aigc filter returns an empty list. Upstream accepts only a single type; there is no "return all" option.

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

Filter by asset name (fuzzy match)

statuses?string

Filter by status: Active, Processing, Failed

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

Response Body

application/json

application/json

application/json

application/json

curl -X get "https://api.xrtoken.ai/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"
}