The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.
使用量與成本管理 API 提供程式化且細緻的存取方式,讓您取得組織的歷史 API 使用量與成本資料。這些資料類似於 Anthropic Console 中使用量成本頁面提供的資訊。 此 API 讓您能夠更好地監控、分析和最佳化您的 Claude 實作:
  • 精確的使用量追蹤: 取得精確的 token 計數和使用模式,而不是僅依賴回應 token 計數
  • 成本對帳: 將內部記錄與 Anthropic 帳單進行比對,供財務和會計團隊使用
  • 產品效能與改進: 監控產品效能,同時測量系統變更是否有所改善,或設定警示
  • 速率限制優先層級最佳化: 最佳化提示快取或特定提示等功能,以充分利用分配的容量,或購買專用容量。
  • 進階分析: 執行比 Console 中更深入的資料分析
需要管理 API 金鑰此 API 是管理 API的一部分。這些端點需要管理 API 金鑰(以 sk-ant-admin... 開頭),與標準 API 金鑰不同。只有具有管理員角色的組織成員才能透過 Anthropic Console 提供管理 API 金鑰。

合作夥伴解決方案

領先的可觀測性平台提供現成的整合功能,用於監控您的 Claude API 使用量和成本,無需撰寫自訂程式碼。這些整合提供儀表板、警示和分析功能,幫助您有效管理 API 使用量。

快速開始

取得您組織過去 7 天的每日使用量:
curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-08T00:00:00Z&\
ending_at=2025-01-15T00:00:00Z&\
bucket_width=1d" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"
為整合設定 User-Agent 標頭如果您正在建立整合,請設定您的 User-Agent 標頭以幫助我們了解使用模式:
User-Agent: YourApp/1.0.0 (https://yourapp.com)

使用量 API

透過 /v1/organizations/usage_report/messages 端點追蹤整個組織的 token 消耗,並按模型、工作區和服務層級進行詳細分解。

關鍵概念

  • 時間桶: 以固定間隔(1m1h1d)彙總使用量資料
  • Token 追蹤: 測量未快取輸入、快取輸入、快取建立和輸出 token
  • 篩選與分組: 按 API 金鑰、工作區、模型、服務層級或上下文視窗進行篩選,並按這些維度分組結果
  • 伺服器工具使用量: 追蹤伺服器端工具(如網路搜尋)的使用量
如需完整的參數詳細資訊和回應架構,請參閱使用量 API 參考

基本範例

按模型的每日使用量

curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-01T00:00:00Z&\
ending_at=2025-01-08T00:00:00Z&\
group_by[]=model&\
bucket_width=1d" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

帶篩選的每小時使用量

curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-15T00:00:00Z&\
ending_at=2025-01-15T23:59:59Z&\
models[]=claude-sonnet-4-20250514&\
service_tiers[]=batch&\
context_window[]=0-200k&\
bucket_width=1h" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

按 API 金鑰和工作區篩選使用量

curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-01T00:00:00Z&\
ending_at=2025-01-08T00:00:00Z&\
api_key_ids[]=apikey_01Rj2N8SVvo6BePZj99NhmiT&\
api_key_ids[]=apikey_01ABC123DEF456GHI789JKL&\
workspace_ids[]=wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ&\
workspace_ids[]=wrkspc_01XYZ789ABC123DEF456MNO&\
bucket_width=1d" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"
若要取得您組織的 API 金鑰 ID,請使用列出 API 金鑰端點。若要取得您組織的工作區 ID,請使用列出工作區端點,或在 Anthropic Console 中找到您組織的工作區 ID。

時間粒度限制

粒度預設限制最大限制使用案例
1m60 個桶1440 個桶即時監控
1h24 個桶168 個桶每日模式
1d7 個桶31 個桶每週/每月報告

成本 API

透過 /v1/organizations/cost_report 端點取得以美元為單位的服務層級成本分解。

關鍵概念

  • 貨幣: 所有成本以美元計算,以最小單位(美分)的十進位字串報告
  • 成本類型: 追蹤 token 使用量、網路搜尋和程式碼執行成本
  • 分組: 按工作區或描述分組成本以進行詳細分解
  • 時間桶: 僅限每日粒度(1d
如需完整的參數詳細資訊和回應架構,請參閱成本 API 參考
優先層級成本使用不同的計費模式,不包含在成本端點中。請透過使用量端點追蹤優先層級使用量。

基本範例

curl "https://api.anthropic.com/v1/organizations/cost_report?\
starting_at=2025-01-01T00:00:00Z&\
ending_at=2025-01-31T00:00:00Z&\
group_by[]=workspace_id&\
group_by[]=description" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

分頁

兩個端點都支援大型資料集的分頁:
  1. 發出初始請求
  2. 如果 has_moretrue,在下一個請求中使用 next_page
  3. 繼續直到 has_morefalse
# 第一個請求
curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-01T00:00:00Z&\
ending_at=2025-01-31T00:00:00Z&\
limit=7" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

# 回應包含:"has_more": true, "next_page": "page_xyz..."

# 帶分頁的下一個請求
curl "https://api.anthropic.com/v1/organizations/usage_report/messages?\
starting_at=2025-01-01T00:00:00Z&\
ending_at=2025-01-31T00:00:00Z&\
limit=7&\
page=page_xyz..." \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

常見使用案例

anthropic-cookbook 中探索詳細實作:
  • 每日使用量報告: 追蹤 token 消耗趨勢
  • 成本歸屬: 按工作區分配費用以進行退費
  • 快取效率: 測量和最佳化提示快取
  • 預算監控: 為支出閾值設定警示
  • CSV 匯出: 為財務團隊產生報告

常見問題

資料有多新?

使用量和成本資料通常在 API 請求完成後 5 分鐘內出現,儘管偶爾可能會有更長的延遲。

建議的輪詢頻率是多少?

API 支援每分鐘輪詢一次以持續使用。對於短時間爆發(例如,下載分頁資料),可以接受更頻繁的輪詢。為需要頻繁更新的儀表板快取結果。

如何追蹤程式碼執行使用量?

程式碼執行成本出現在成本端點中,在描述欄位中按 Code Execution Usage 分組。程式碼執行不包含在使用量端點中。

如何追蹤優先層級使用量?

在使用量端點中按 service_tier 篩選或分組,並尋找 priority 值。優先層級成本在成本端點中不可用。

Workbench 使用量會發生什麼?

來自 Workbench 的 API 使用量不與 API 金鑰關聯,因此即使按該維度分組,api_key_id 也會是 null

預設工作區如何表示?

歸屬於預設工作區的使用量和成本的 workspace_id 值為 null

另請參閱

使用量與成本 API 可用於幫助您為使用者提供更好的體驗、幫助您管理成本,以及保護您的速率限制。了解更多關於這些其他功能的資訊: