接入文档

十分钟接入。

一个 API Key,一个 POST 接口,或者用零依赖 SDK 包一层。成本按调用发生当时的价目结算,历史账单永远可复算。

接入路径
1创建 API Key
API Key 页面,明文只显示一次
2上报用量
POST /v1/events,或包一层 SDK
3看板归因
按租户 / 功能 / 模型自动算单位经济学
端点POST /v1/events

1 · 创建 API Key

注册后进入 API Key 页面创建,形如 vc_live_xxxxxxxx…。明文只显示一次,服务端只存 sha256。

2 · 上报用量

把 provider 返回的 usage 透传上来即可

方式 A:HTTP 接口

字段与 OpenAI / Anthropic 的 usage 结构一致,可以直接透传。

curl -X POST https://your-host/v1/events \
  -H "Authorization: Bearer vc_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [{
      "id": "req_abc123",
      "occurredAt": "2026-10-02T09:12:00Z",
      "tenantId": "acme-corp",
      "feature": "report-gen",
      "taskId": "task-8841",
      "provider": "anthropic",
      "model": "claude-opus-4.6",
      "usage": { "inputTokens": 12000, "cachedInputTokens": 9000, "outputTokens": 4000 },
      "status": "ok",
      "latencyMs": 18400
    }]
  }'

id 是幂等键:同一账号下重复上报同一个 id 不会重复计费。建议直接复用你的请求 ID。

方式 B:SDK

仓库 sdk/node 与 sdk/python 下有零依赖实现,把 provider 客户端包一层即可自动上报。

3 · 字段说明

只有 status 是最容易被忽略的必填项
字段必填说明
id是幂等键,账号内唯一
occurredAt是RFC3339 时间。成本按该时刻的价目与汇率结算
tenantId是你的终端客户 / 租户标识
feature否功能场景,用于按功能下钻
taskId否把 Agent 扇出的多次调用归到同一个业务动作
provider/model是用于匹配价格库;支持别名与前缀匹配
usage是token 用量,透传 provider 返回的 usage 即可
status是ok / error / timeout / cancelled。失败调用同样计费,并单独统计为白花成本

4 · 两条必须知道的口径

✓成本按调用发生当时的价目与汇率结算
不是按今天的。所以历史数据入库后不会被后续调价影响,报表永远可复算。
△算不出来的,就不给数字
价格库里没有的模型不会被丢弃,而是以「成本未知」入库,并在看板的「数字可信度」面板里明确列出。