使用记录
使用记录API文档使用接入密钥查询当前账号的消耗、充值、退款和错误记录
可下载使用记录API文档,交给 AI 编程助手接入分页查询、金额和公式展示及错误排查。
此接口返回与控制台「使用记录」相同的数据,包括模型、线路 ID、消耗、累计消耗、完整计算公式、计费快照和错误内容。查询范围是接入密钥所属账号的全部记录,包含该账号其他令牌产生的记录。
生成前的预计费用和计算公式见计算生成费用。
查询记录
GET /api/platform/logs
Authorization: Bearer sk-你的令牌这个查询接口使用站点根地址,无需在路径前加 /v1。无需浏览器登录或 Cookie。必须使用有效且未过期、未停用的接入密钥;查询不消耗模型额度。
curl 'https://your-domain.example/api/platform/logs?p=1&page_size=20&type=0' \-H 'Authorization: Bearer sk-你的令牌'| 参数 | 默认值 | 说明 |
|---|---|---|
p | 1 | 页码,从 1 开始,最大 999。超出范围时按边界值处理。 |
page_size | 20 | 每页条数,范围 1–50。超出范围时按边界值处理。 |
type | 0 | 0 全部、1 充值、2 消耗、5 错误、6 退款;其他值按全部处理。 |
记录按时间倒序排列。根据 data.total 和 data.page_size 计算总页数,逐页获取完整明细。查询范围固定为密钥所属账号,不能通过传入用户 ID、渠道或管理员参数查询其他账号。
返回示例
{
"success": true,
"data": {
"page": 1,
"page_size": 20,
"total": 1,
"items": [
{
"id": 7,
"created_at": 1792500000,
"type": 5,
"model_name": "kimi-k3",
"line_id": 115,
"token_name": "业务接入",
"quota": 0,
"cumulative_quota": 500000,
"amount": "-",
"cumulative_amount": "¥7.30",
"billing_formula": "—",
"billing": {},
"prompt_tokens": 0,
"completion_tokens": 0,
"use_time": 1,
"endpoint_path": "/v1/chat/completions",
"is_stream": false,
"request_id": "req_example",
"content": "请求处理失败,请重试"
}
]
}
}| 字段 | 说明 |
|---|---|
id、created_at | 记录 ID、Unix 秒级时间戳。 |
type | 记录类型;充值为成功,消耗和退款为完成,错误为失败。 |
model_name、line_id | 调用的模型和线路 ID;未记录线路时可能省略 line_id。 |
quota | 本条记录的原始额度值;含义由 type 区分,不要将充值、退款当作消耗。 |
cumulative_quota | 截至该时间的累计消耗,与页面口径一致;暂时无法计算时省略,不代表零。 |
amount、cumulative_amount | 与页面相同的消耗金额、累计消耗展示文本,包含币种符号或点数单位;零消耗显示 -,未知额度显示 --。 |
billing_formula | 与页面相同的完整计算公式;缺少计费快照或不适用时为 —。 |
billing | 该次调用保留的计费快照,可能包含单价、倍率、数量、视频秒数、缓存和补扣/退款数据;历史记录可能为空。 |
prompt_tokens、completion_tokens | 输入、输出 Token 数。 |
use_time | 耗时,单位为秒。 |
endpoint_path | 调用的接口路径。 |
token_name | 产生记录的令牌名称。 |
request_id、upstream_request_id | 请求追踪编号;未记录时可能为空或省略。 |
is_stream | 是否为流式请求。 |
content | 日志内容;type=5 时为页面「查看错误」展示的错误信息,未记录时可能为空。 |
金额与计算公式
amount、cumulative_amount 和 billing_formula 可直接用于展示,由原始额度、该次调用的 billing 快照及站点显示配置计算,无需自行拼接公式。
如需数值计算,使用 quota 和 cumulative_quota,不要解析金额展示文本。
可通过以下接口读取显示配置:
curl 'https://your-domain.example/api/platform/status'配置位于 data:quota_per_unit 表示每美元对应的额度,quota_display_type 决定显示方式。
USD:金额为quota / quota_per_unit美元。CNY:金额为quota / quota_per_unit × price元。TOKENS:直接显示原始额度点数。CUSTOM:金额为quota / quota_per_unit × custom_currency_exchange_rate,符号为custom_currency_symbol。
累计消耗使用相同换算。计算公式使用该条记录的 billing 快照,不套用当前模型价格;快照缺失时不反推或编造公式。
错误处理
鉴权失败返回 HTTP 401,响应包含 success: false 和 message。查询失败返回非 2xx 状态;若返回 429,请按提示等待后重试。响应禁止缓存。
查询错误记录的示例:
curl 'https://your-domain.example/api/platform/logs?p=1&page_size=20&type=5' \-H 'Authorization: Bearer sk-你的令牌'