跳转到主要内容

概览

管理 API 用于自动化管理组织级 API Key,并查询单个 Key 维度的用量与账单,无需使用普通推理 API Key。 管理令牌可以在 Dashboard 的 Settings 页面生成和轮换:
Authorization: Bearer mt-your-management-token
管理令牌不是推理 API Key。mt-... 用于 /v1/management/*sk-... 用于 /v1/responses 等模型推理接口。

可用接口

EndpointMethod说明
/v1/management/api-keysGET列出当前组织下的用户 API Key
/v1/management/api-keysPOST创建新的用户 API Key
/v1/management/api-keys/{keyId}PATCH更新名称、额度、模型白名单、过期时间或状态
/v1/management/api-keys/{keyId}/usageGET查询指定 Key 的分页用量明细
/v1/management/api-keys/{keyId}/billingGET查询指定 Key 的聚合账单明细

用量筛选契约

GET /v1/management/api-keys/{keyId}/usage 支持以下 query 参数:
参数类型默认值 / 限制说明
pageinteger默认 1,最小 11-based 页码
limitinteger默认 50,最小 1,最大 100每页条数
logicalModelstring最大长度 100请求时使用的逻辑模型名
modelVendorstring最大长度 100公开模型厂商
sceneenum-chatimageaudiovideoembeddingreranktranslationmusic3d
accessChannelenum-platformbyok
startDatestring-起始时间,接受带时区的 RFC3339 或 YYYY-MM-DD
endDatestring-结束时间,接受带时区的 RFC3339 或 YYYY-MM-DD
如果同时提供 startDateendDate,则 startDate 必须早于或等于 endDate

API Key Body 契约

POST /v1/management/api-keys

字段类型默认值 / 限制说明
namestring必填,默认 Default Key,长度 1-50展示名称,服务端会先 trim
limitAmountnumber | null最小 0,最大 100000null 或省略 = 不限额,0 = 零额度,正数 = 美元上限
limitCurrencyenum默认 USD可选:USDCNY。当设置为 CNY 时,limitAmount 会按人民币理解,并在服务端按当前汇率换算成 USD 后存储
modelsstring[]默认 []可选的逻辑模型白名单
expiresAtstring | nullRFC3339 datetimenull 表示永不过期

PATCH /v1/management/api-keys/

字段类型默认值 / 限制说明
statusenum-activeinactiverevoked
namestring长度 1-50更新后的展示名称
limitAmountnumber | null最小 0,最大 100000null = 不限额,0 = 零额度
limitCurrencyenum默认 USD可选:USDCNY。当设置为 CNY 时,limitAmount 会按人民币理解,并在服务端按当前汇率换算成 USD 后存储
modelsstring[]-更新后的逻辑模型白名单
expiresAtstring | nullRFC3339 datetimenull 表示清除过期时间
PATCH 请求至少需要提供一个字段。

金额契约

  • 默认情况下,请求体里的 limitAmount 按 USD 理解。若传 limitCurrency: "CNY",则表示人民币限额,服务端会按当前汇率换算成 USD 后存储。
  • 响应里的金额字段保留原始 USD 字段,并额外返回一个 _cny 结尾的人民币展示字段。
  • API Key 元数据里的 exchange_rate 表示本次响应中所有 *_cny 字段使用的 USD→CNY 汇率。

报表语义

  • logicalModel 表示调用方请求的公开逻辑模型。
  • modelVendor 表示公开模型厂商,不是隐藏的物理路由。
  • scene 表示公开请求场景,由接口或任务类型归一化得到。
  • accessChannel=platform 表示通过 LemonData 平台渠道计费。
  • accessChannel=byok 表示请求使用了你自己的上游 Provider Key。
接口只返回公开可理解的账单与报表字段,不暴露内部路由细节或物理渠道元数据。

Billing 分页说明

/usage 是分页接口;/billing 当前返回的是聚合账单拆分结果,不返回 page / limit 风格的分页元数据。如果你需要逐条记录,请优先使用 /usage

快速示例

先用当前管理令牌列出这个组织下的 API Keys:
curl "https://api.lemondata.cc/v1/management/api-keys" \
  -H "Authorization: Bearer mt-your-management-token"
{
  "object": "list",
  "data": [
    {
      "id": "key_abc123def456",
      "name": "Backend Worker",
      "key_prefix": "sk-abc123...",
      "status": "active",
      "limit_amount": 500.0,
      "limit_amount_cny": 3600.0,
      "used_amount": 148.25,
      "used_amount_cny": 1067.4,
      "exchange_rate": 7.2,
      "models": ["gpt-4o-mini", "claude-3-7-sonnet"],
      "expires_at": "2026-04-30T00:00:00.000Z",
      "last_used_at": "2026-03-27T08:12:45.000Z",
      "created_at": "2026-03-01T10:00:00.000Z"
    }
  ]
}

下一步