跳轉到主要內容

概覽

Management 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,最小 1從 1 開始的頁碼
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顯示名稱,伺服器端會先去除前後空白
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 是由 endpoint 或任務型別推導出的公開請求場景。
  • accessChannel=platform 表示該請求是透過 LemonData 平台渠道計費。
  • accessChannel=byok 表示該請求使用了你自己的上游 Provider Key。
介面只會回傳公開可理解的 billing 與 reporting 欄位,不會暴露內部 routing 細節或實體渠道中繼資料。

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"
    }
  ]
}

下一步