API 文档管理接口用量

拉取用量明细

🔐 需要 PAT 鉴权(User 权限)

按时间分页拉取当前账号下的消耗用量明细(数据来自类型为「消耗」的用量日志)。用于对账与计量;不推送数据,由调用方主动 Pull。

Base URL

  • https://api.autorouter.top — Production

Authentication

本接口使用 系统访问令牌(PAT)+ Auto-Api-User 鉴权,不能使用 sk-xxx 形式的 API Key。

Header说明
Authorization系统访问令牌。格式:Bearer {system_access_token}。在「个人中心 → 个人资料 → 访问令牌」中生成。Bearer 前缀可省略。
Auto-Api-User当前登录用户 ID,必须与令牌所属用户一致。可在「个人中心 → 个人资料 → 用户 ID」处复制。

鉴权成功后,返回该用户账号下的全部消耗记录;可用查询参数 token_name 再缩小到某个令牌。

Endpoints

GET /api/usage/records

拉取用量明细

🔐 需要 PAT 鉴权(User 权限)

Query Parameters

NameTypeRequiredDescription
start_timestampintegerNo起始时间(Unix 秒,按 created_at >=)。0 或不传表示不限制
end_timestampintegerNo结束时间(Unix 秒,按 created_at <=)。0 或不传表示不限制
model_namestringNo按模型名称过滤(模糊匹配)
token_namestringNo按令牌名称精确过滤
request_idstringNo按请求 ID 精确过滤
pintegerNo页码,从 1 开始,默认 1
page_sizeintegerNo每页条数,默认 10,最大 100

接口固定只返回消耗类型记录,无需传 type。

Responses

200: 成功

Content-Type: application/json

401: 未提供 access token,或未提供 Auto-Api-User

access token 无效时,HTTP 状态码仍是 200,success 为 false。

响应字段

顶层
字段类型说明
successboolean是否成功
messagestring错误信息,成功时为空字符串
dataobject分页数据
data 分页
字段类型说明
pageinteger当前页码
page_sizeinteger每页条数
totalinteger符合条件的总条数
itemsarray用量明细列表
data.items[] 用量记录
字段类型说明
created_atinteger结算写入时间(Unix 秒)
model_namestring模型名称
token_namestring令牌名称
token_idinteger令牌 ID
request_idstring请求 ID
amountnumber本次最终应付金额(美元)。同一 request_id 下,消耗金额合计减去退款金额合计。补扣差额已并入,不单独成行。全额退款时为 0。
billing_statusstringcharged:仍有应付金额,计入对账。refunded:该次已全额退回,amount 为 0,不计入次数和金额
prompt_tokensinteger输入 Token 数(不适用时为 0)
completion_tokensinteger输出 Token 数(不适用时为 0)
resolutionstring视频输出分辨率(如 480p / 720p / 1080p / 4k)。非视频或未记录时为空字符串
duration_secondsnumber视频时长(秒)。无则省略
is_taskboolean是否为异步任务类生成
task_idstring任务 ID。无则省略

说明

  • 一条成功结算的消耗记录对应一次可计量用量;可按 created_at 与 resolution 自行做小时/日汇总。
  • resolution 依赖计费链路写入;部分模型或计费方式可能为空,调用方应按空值处理,不要假设每条都有分辨率。
  • 对账只加总 billing_status 为 charged 的 amount。refunded 表示该次已全额退回。
  • 时间筛选按原始消耗时间。之后发生的退款或补扣仍会改变该行 amount。

请求示例

curl -X GET "https://api.autorouter.top/api/usage/records?start_timestamp=1717200000&end_timestamp=1717286400&page_size=50&p=1" \
  -H "Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN" \
  -H "Auto-Api-User: YOUR_USER_ID"

响应示例

{
  "success": true,
  "message": "",
  "data": {
    "page": 1,
    "page_size": 50,
    "total": 2,
    "items": [
      {
        "created_at": 1717234567,
        "model_name": "seedance-1.5-pro",
        "token_name": "prod-key",
        "token_id": 42,
        "request_id": "req_abc123",
        "amount": 0.3,
        "billing_status": "charged",
        "prompt_tokens": 0,
        "completion_tokens": 0,
        "resolution": "1080p",
        "duration_seconds": 5,
        "is_task": true,
        "task_id": "task_xyz"
      },
      {
        "created_at": 1717234000,
        "model_name": "gpt-4o",
        "token_name": "prod-key",
        "token_id": 42,
        "request_id": "req_def456",
        "amount": 0.0064,
        "billing_status": "charged",
        "prompt_tokens": 120,
        "completion_tokens": 80,
        "resolution": "",
        "is_task": false
      }
    ]
  }
}

目录