XRToken API 文档

素材库火山兼容端点

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

火山 Ark Open API 格式的素材库兼容入口。把 base URL 指向 XRToken 后, 请求路径 / 参数 / 响应与火山官方保持一致,鉴权用 XRToken API key (Authorization: Bearer tr-xxxx-api-key: tr-xxx),不需要 AK/SK。

通过 query 参数 Action 区分操作,路径一律是官方 POST /?Action=...

  • Action=CreateAssetGroup:创建素材组。ProjectName 非必填:不传时自动使用网关项目(当前 xrtoken);显式传值(包括 default)原样透传。
  • Action=CreateAsset:创建素材。ProjectName 非必填:不传时自动使用网关项目(当前 xrtoken);显式传值(包括 default)原样透传;Name 可选。
  • Action=GetAssetGroup:查询素材组,body 传 {"Id": "group-xxx"}
  • Action=GetAsset:查询素材,body 传 {"Id": "asset-xxx"}
  • Action=ListAssetGroups:列出素材组。
  • Action=ListAssets:列出素材。
  • Action=UpdateAssetGroup:更新素材组。
  • Action=UpdateAsset:更新素材。
  • Action=DeleteAssetGroup:删除素材组。
  • Action=DeleteAsset:删除素材。
  • Action=CreateVisualValidateSession:创建真人核验会话。
  • Action=GetVisualValidateResult:查询真人核验结果。

响应沿用火山 ResponseMetadata / Result 信封,并保持素材库账号隔离 (只能操作自己名下的分组和素材)。

POST
/

Authorization

BearerAuth
AuthorizationBearer <token>

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

Authorization: Bearer tr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Query Parameters

Action*string

操作类型:

  • CreateAssetGroup -- 创建素材组
  • CreateAsset -- 创建素材
  • GetAssetGroup -- 查询素材组
  • GetAsset -- 查询素材
  • ListAssetGroups -- 列出素材组
  • ListAssets -- 列出素材
  • UpdateAssetGroup -- 更新素材组
  • UpdateAsset -- 更新素材
  • DeleteAssetGroup -- 删除素材组
  • DeleteAsset -- 删除素材
  • CreateVisualValidateSession -- 创建真人核验会话
  • GetVisualValidateResult -- 查询真人核验结果
Value in"CreateAssetGroup" | "CreateAsset" | "GetAssetGroup" | "GetAsset" | "ListAssetGroups" | "ListAssets" | "UpdateAssetGroup" | "UpdateAsset" | "DeleteAssetGroup" | "DeleteAsset" | "CreateVisualValidateSession" | "GetVisualValidateResult"
Version?string

接口版本,默认 2024-01-01

Default"2024-01-01"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X post "https://api.xrtoken.net/?Action=CreateAssetGroup" \  -H "Content-Type: application/json" \  -d '{    "Name": "my-assets"  }'
{}
{
  "error": "model field is required",
  "type": "invalid_request_error"
}
{
  "error": "invalid or missing API key",
  "type": "auth_error"
}
{
  "error": "string",
  "type": "invalid_request_error"
}
{
  "error": "string",
  "type": "invalid_request_error"
}
{
  "error": "rate limit exceeded",
  "type": "rate_limit_error"
}
{
  "error": "upstream provider error",
  "type": "server_error"
}