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
| Name | Type | Required | Description |
|---|---|---|---|
start_timestamp | integer | No | 起始时间(Unix 秒,按 created_at >=)。0 或不传表示不限制 |
end_timestamp | integer | No | 结束时间(Unix 秒,按 created_at <=)。0 或不传表示不限制 |
model_name | string | No | 按模型名称过滤(模糊匹配) |
token_name | string | No | 按令牌名称精确过滤 |
request_id | string | No | 按请求 ID 精确过滤 |
p | integer | No | 页码,从 1 开始,默认 1 |
page_size | integer | No | 每页条数,默认 10,最大 100 |
接口固定只返回消耗类型记录,无需传 type。
Responses
200: 成功
Content-Type: application/json
401: 未提供 access token,或未提供 Auto-Api-User
access token 无效时,HTTP 状态码仍是 200,success 为 false。
响应字段
顶层
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
message | string | 错误信息,成功时为空字符串 |
data | object | 分页数据 |
data 分页
| 字段 | 类型 | 说明 |
|---|---|---|
page | integer | 当前页码 |
page_size | integer | 每页条数 |
total | integer | 符合条件的总条数 |
items | array | 用量明细列表 |
data.items[] 用量记录
| 字段 | 类型 | 说明 |
|---|---|---|
created_at | integer | 结算写入时间(Unix 秒) |
model_name | string | 模型名称 |
token_name | string | 令牌名称 |
token_id | integer | 令牌 ID |
request_id | string | 请求 ID |
amount | number | 本次最终应付金额(美元)。同一 request_id 下,消耗金额合计减去退款金额合计。补扣差额已并入,不单独成行。全额退款时为 0。 |
billing_status | string | charged:仍有应付金额,计入对账。refunded:该次已全额退回,amount 为 0,不计入次数和金额 |
prompt_tokens | integer | 输入 Token 数(不适用时为 0) |
completion_tokens | integer | 输出 Token 数(不适用时为 0) |
resolution | string | 视频输出分辨率(如 480p / 720p / 1080p / 4k)。非视频或未记录时为空字符串 |
duration_seconds | number | 视频时长(秒)。无则省略 |
is_task | boolean | 是否为异步任务类生成 |
task_id | string | 任务 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
}
]
}
}