跳至主要內容

Claude Enterprise Admin API 參考指南

本指南涵蓋使用 Claude Enterprise Admin API 為您的 Claude Enterprise 組織設定的支出限額支出限額增加請求。支出限額可讓您在循環期間內限制每個成員的使用額度支出、查看每個成員的限額來源,以及審查或處理成員提出的更高限額請求。

如需按使用者和時間分組的使用情況和成本報告,請參閱Claude Enterprise Analytics API 參考指南

Claude Enterprise Admin API 目前處於公開測試版,可供啟用使用額度的 Enterprise 方案組織使用。

概述

共有八個端點分佈在兩個資源中:

資源

端點

用途

支出限額

GET /v1/organizations/spend_limits/effective

GET /v1/organizations/spend_limits/{spend_limit_id}

POST /v1/organizations/spend_limits

DELETE /v1/organizations/spend_limits/{spend_limit_id}

讀取每個成員的有效限額和期間至今的支出;設定或清除按使用者的覆蓋。

支出限額增加請求

GET /v1/organizations/spend_limit_increase_requests

GET /v1/organizations/spend_limit_increase_requests/{id}

POST /v1/organizations/spend_limit_increase_requests/{id}/approve

POST /v1/organizations/spend_limit_increase_requests/{id}/deny

列出成員提出的更高限額請求及做出決定所需的背景資訊;批准或拒絕每個請求。

使用支出限額端點回答「每個成員適用什麼限額、它來自何處,以及他們距離限額有多近?」並設定按使用者的覆蓋。使用支出限額增加請求端點處理成員提交的請求佇列。

先決條件和身份驗證

  • 您的組織必須採用 Claude Enterprise 方案。

  • 必須為您的組織啟用使用額度。您的主要所有者可以在 Claude 中的帳單設定下啟用此功能。

  • 主要所有者需要使用以下一個或兩個範圍鑄造 Admin API 金鑰:

    • read:spend_limits(所有 GET 端點必需)

    • write:spend_limitsPOSTDELETE 端點必需)

在每個請求的x-api-key標頭中傳遞金鑰。

重要:不要公開分享 API 金鑰或將其簽入原始碼控制。

基礎 URL

https://api.anthropic.com

速率限制

所有八個端點共享單一的每個組織限制,為每分鐘 60 個請求。超過限制的請求會傳回429 Too Many Requests

分頁

GET /v1/organizations/spend_limits/effectiveGET /v1/organizations/spend_limit_increase_requests 使用不透明遊標進行分頁。第一個請求傳回最多 limit 行加上 next_page 遊標。在下一個請求中將該遊標原封不動地作為 page 參數傳遞,並重複此操作直到 next_pagenull

重要:不要在序列中途更改查詢參數。遊標綁定到發出它們的篩選器。如果您更改 user_ids[]status[]actor_ids[] 並傳遞舊遊標,您將收到 400 錯誤,顯示「遊標與目前查詢參數不符」。請改為從第一頁開始新序列。

將遊標字串視為不透明:不要自行解析、修改或構造它。

序列化列表參數

列表參數使用括號表示法:對每個值重複參數名稱加上 []

user_ids[]=user_01AbCdEfGh&user_ids[]=user_01JkLmNoPq

錯誤回應

狀態

含義

400

無效的輸入、不支援的參數值、頁面遊標與目前參數不符,或不符合先決條件(請參閱各端點驗證)。

401

缺少 x-api-key 標頭。

403

API 金鑰缺少必需的範圍(read:spend_limitswrite:spend_limits)。

404

找不到資源,或 API 金鑰未知、已過期或已被撤銷。

429

超過速率限制。

500

內部錯誤。

錯誤主體具有以下形式:

{"type": "error", "error": {"type": "<error_type>", "message": "..."}, "request_id": "req_..."}

error.type 是狀態相關的判別器:invalid_request_error (400)、authentication_error (401)、permission_error (403)、not_found_error (404)、rate_limit_error (429)、api_error (500)。request_id 始終存在,是聯絡支援時應引用的值。每個端點下的驗證表列出特定訊息。


概念

支出限額階層

每個成員的使用額度支出受到有效支出限額的限制,該限額從範圍級別的階層中解析。當成員沒有按使用者覆蓋時,他們會繼承為其座位層級、其群組(如果您的組織使用基於群組的限制)或組織範圍預設值配置的限額。

讀取 GET /v1/organizations/spend_limits/effective 會傳回每個目前成員及其已解析的有效限額、該限額的解析來源 (source) 和其期間至今的支出。透過 POST /v1/organizations/spend_limits 設定按使用者覆蓋會將成員固定到特定限額,無論他們本來會繼承什麼。刪除覆蓋會將他們返回到繼承的限額。

範圍

範圍識別支出限額的寫入或解析級別:

類型

欄位

含義

user

user_id

特定成員。user_id 與管理員 API 使用者端點傳回的 ID 相符。

seat_tier

seat_tier

座位層級預設值。seat_tier 值是完全限定的識別碼,例如 enterprise_standardenterprise_tier_1;可能會新增其他值。

rbac_group

rbac_group_id

群組預設值,當您的組織按群組管理限制時。

organization

組織範圍的預設值。

scope.type 是開放字串。用戶端應將未知值視為不透明並回退,而不是失敗。未來可能會新增其他範圍類型。

期間

period 是強制執行限制和支出重設的循環視窗。目前唯一的值是 "monthly"

period 是開放字串。用戶端應將未知值視為不透明並回退,而不是失敗。未來可能會新增其他期間值。

金額和貨幣

所有貨幣值都是組織計費貨幣的最小單位(美元的美分)中的字串。例如,"50000" 代表 500.00 美元。解析為十進位並除以 100 以顯示美元。避免對大值使用二進位浮點。

amount可為空值null 表示無限制(無限制)。"0" 表示該成員已停用使用額度。

period_to_date_spend 是成員自目前 period 開始以來累積的使用額度,採用相同的最小單位格式。它可能包含小數部分(例如,"41280.125")。

增加請求生命週期

當成員在 claude.ai 中點擊「請求更多使用」時,會建立支出限額增加請求。請求不是透過此 API 建立的。

狀態

含義

pending

等待管理員操作。請求通常會帶有即時 spend_summary,以便您在決定時可以看到成員的目前有效限額和期間至今的支出。如果無法計算,spend_summary 可能為 null,因此請處理該情況。

approved

請求已透過核准解決:管理員明確核准了它(以管理員提供的金額寫入按使用者支出限額)、另一個管理員操作使使用額度可供成員使用(例如,提高座位層級限制或為組織啟用使用額度計費),或 Anthropic 支援代表組織提高了限制。spend_summarynull

denied

管理員拒絕。spend_summarynull。Claude.ai 從 resolved_at 起 30 天內隱藏該成員的請求按鈕;管理員仍可隨時直接提高成員的限額。

approveddenied 都是終端。成員最多一次只能有一個 pending 請求。

透過 POST …/approve 核准會寫入與 POST /v1/organizations/spend_limits 相同的按使用者支出限額列。直接設定支出限額不會轉換待決請求。使用核准端點來解決請求。

根據預設,Anthropic 會在成員的請求被核准或拒絕時向其發送電子郵件。在核准或拒絕時傳遞 suppress_notification: true 以抑制該電子郵件(例如,當您自己的系統通知成員時)。


SpendLimit 物件

在一個範圍級別設定的限制。

{
"type": "spend_limit",
"id": "spl_01AbCdEfGhIjKlMnOpQrSt",
"created_at": "2026-05-01T12:00:00Z",
"updated_at": "2026-05-03T09:14:11Z",
"scope": { "type": "user", "user_id": "user_01AbCdEfGh" },
"amount": "50000",
"currency": "USD",
"period": "monthly"
}

欄位

類型

說明

type

字串

始終為 "spend_limit"

id

字串

前綴為 spl_

created_at

字串 (RFC 3339)

首次設定此限制的時間。

updated_at

字串 (RFC 3339)

上次變更此限制的時間。

scope

範圍

此限制所在的級別。請參閱「範圍」部分。

amount

字串或 null

period 的限制,以最小單位表示。null 表示無限制。

currency

字串

ISO 4217。組織的帳單貨幣。

period

字串

強制執行 amount 的循環時間窗口。請參閱「期間」部分。

SpendSummary 物件

計算的每個成員報告行:成員的有效限制、其來源以及其期間至今的支出。不是可定址的資源(沒有 id)。

{
"scope": { "type": "user", "user_id": "user_01AbCdEfGh" },
"amount": "50000",
"currency": "USD",
"period": "monthly",
"source": { "type": "seat_tier", "seat_tier": "enterprise_standard" },
"spend_limit_id": "spl_01XyZaBcDeFgHiJkLmNoPq",
"period_to_date_spend": "31402.5"
}

欄位

類型

說明

scope

範圍(type: "user"

此行所針對的成員。

amount

字串或 null

period 的有效限制,以最小單位表示。null 表示無限制;"0" 表示使用額度已停用。

currency

字串

ISO 4217。

period

字串

source 解析到的支出限制期間。請參閱「期間」部分。

source

範圍

amount 在階層中的解析來源。當成員有每個使用者覆蓋時等於 scope

spend_limit_id

字串

SpendLimit 的 ID,source 已解析到該 ID。使用 GET /v1/organizations/spend_limits/{spend_limit_id} 取得。

period_to_date_spend

字串

成員自當前 period 開始以來累積的使用額度,以最小單位計。

SpendLimitIncreaseRequest 物件

{
"type": "spend_limit_increase_request",
"id": "slir_01AbCdEfGhIjKlMnOpQrSt",
"created_at": "2026-05-04T16:22:09Z",
"status": "pending",
"resolved_at": null,
"resolved_by": null,
"actor": {
"type": "user_actor",
"user_id": "user_01AbCdEfGh",
"name": "Jane Smith",
"email_address": "[email protected]"
},
"spend_summary": {
"scope": { "type": "user", "user_id": "user_01AbCdEfGh" },
"amount": "50000",
"currency": "USD",
"period": "monthly",
"source": { "type": "seat_tier", "seat_tier": "enterprise_standard" },
"spend_limit_id": "spl_01XyZaBcDeFgHiJkLmNoPq",
"period_to_date_spend": "48900"
}
}

欄位

類型

說明

type

字串

始終為 "spend_limit_increase_request"

id

字串

前綴為 slir_

created_at

字串 (RFC 3339)

成員提交請求的時間。

status

字串

pendingapproveddenied

resolved_at

字串 (RFC 3339) 或 null

請求被批准或拒絕的時間。待處理時為 null

resolved_by

Actor 或 null

批准或拒絕請求的人:可以是 user_actor(管理員在 claude.ai 中執行操作)或 scoped_api_key_actor(透過此 API 解析)。當管理員在 claude.ai 中自動解析請求時(例如,提高座位層級限制、為組織啟用使用額度計費,或提高成員的限制),resolved_by 是執行操作的管理員的 user_actor。待處理時為 null、解析管理員的帳戶已被刪除時為 null,或請求由 Anthropic 支援解析時為 nullscoped_api_key_actor 可能參考已被刪除或撤銷的金鑰。將 scoped_api_key_id 視為歷史參考,並容許查詢失敗。

actor

Actor (user_actor)

提交請求的成員。

spend_summary

SpendSummary 或 null

請求者的即時決策背景:其有效限制和期間至今的支出。當 status 為待處理時存在(如果無法計算摘要,可能為 null);解析後始終為 null

Actor

欄位

類型

說明

type

字串

user_actorscoped_api_key_actor

user_id

字串

出現在 user_actor 上。使用者的 ID;與 actor_ids[] 接受的值相同。

name

字串或 null

出現在 user_actor 上。使用者的名稱;如果帳戶已被刪除或使用者未設定名稱,則為 null

email_address

字串或 null

出現在 user_actor 上。使用者的電子郵件;如果帳戶已被刪除,則為 null

scoped_api_key_id

字串

出現在 scoped_api_key_actor。前綴為 apikey_


支出限額

1. 列出有效的支出限額

GET /v1/organizations/spend_limits/effective

傳回組織的每個目前成員及其已解析的有效限額和期間迄今支出。沒有按使用者覆蓋的成員會顯示 source.typeseat_tierrbac_grouporganization。前成員不會列出。

需要範圍:read:spend_limits.

查詢參數

欄位

類型

必需

預設

說明

user_ids[]

字串,最多 100 個項目

所有成員

縮小到特定成員。接受 user_... ID。不是目前成員的項目會從 data 中無聲地省略。

limit

整數 1–1000

20

每頁列數。

page

不透明遊標字串

來自先前回應的 next_page 值。

回應欄位

欄位

類型

說明

data

SpendSummary 陣列

每個成員一個項目,按成員加入組織的時間排序(最新優先)。

next_page

字串或 null

下一頁的不透明遊標;沒有更多頁面時為 null

範例要求

curl "https://api.anthropic.com/v1/organizations/spend_limits/effective?limit=20" \
-H "x-api-key: $ANTHROPIC_ADMIN_KEY"

範例回應

{
"data": [
{
"scope": { "type": "user", "user_id": "user_01AbCdEfGh" },
"amount": "50000",
"currency": "USD",
"period": "monthly",
"source": { "type": "seat_tier", "seat_tier": "enterprise_standard" },
"spend_limit_id": "spl_01XyZaBcDeFgHiJkLmNoPq",
"period_to_date_spend": "31402.5"
}
],
"next_page": "page_..."
}

驗證

條件

狀態

訊息

user_ids[] 項目格式不正確

400

user_ids[]: entry is not a valid user ID

user_ids[] 有超過 100 個項目

400

limit 超出 1–1000 範圍

400

page 遊標無效

400

page: 無效的遊標

page 遊標與目前的 user_ids[] 不符

400

page: 遊標與目前的查詢參數不符

page 遊標來自不同的 API 版本

400

page: 遊標由不同的 API 版本發出

組織未採用企業方案

400

此端點不支援此組織類型

未啟用使用額度計費

400

此組織未啟用超額計費


2. 取得支出限額

GET /v1/organizations/spend_limits/{spend_limit_id}

按 ID 傳回單一支出限額。使用此功能檢查 SpendSummary.spend_limit_idPOST 回應所參考的列。

需要範圍:read:spend_limits

路徑參數

欄位

類型

說明

spend_limit_id

字串

前綴為 spl_

回應

SpendLimit 物件。

範例請求

curl "https://api.anthropic.com/v1/organizations/spend_limits/spl_01AbCdEfGhIjKlMnOpQrSt" \
-H "x-api-key: $ANTHROPIC_ADMIN_KEY"

驗證

條件

狀態

訊息

spend_limit_id 在此組織中找不到

404

組織未採用企業方案

400

此端點不支援此組織類型

未啟用使用額度計費

400

此組織未啟用超額計費


3. 設定支出限額

POST /v1/organizations/spend_limits

設定每位使用者支出限額覆蓋。更新插入:為已有限額的使用者設定限額會就地覆蓋。

僅接受 scope.type: "user"。座位層級、群組和組織層級預設值在 claude.ai 設定中設定。

直接設定支出限額不會轉換成員的待處理增加請求。使用核准端點來解決請求。

需要範圍:write:spend_limits

請求本文

欄位

類型

必要

說明

scope

物件

{ "type": "user", "user_id": "user_..." }

amount

字串或 null

period 的新限額,以小單位表示,為非負整數十進位字串。"0" 會停用成員的使用額度。null 會移除限額(無限制)。

period

字串

預設值 "monthly"。請參閱「期間」部分。

回應

反映已寫入覆寫的 SpendLimit 物件。

範例請求

curl -X POST "https://api.anthropic.com/v1/organizations/spend_limits" \
-H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
-H "content-type: application/json" \
-d '{"scope": {"type": "user", "user_id": "user_01AbCdEfGh"}, "amount": "75000"}'

範例回應

{
"type": "spend_limit",
"id": "spl_01RsTuVwXyZaBcDeFgHiJk",
"created_at": "2026-05-11T10:02:44Z",
"updated_at": "2026-05-11T10:02:44Z",
"scope": { "type": "user", "user_id": "user_01AbCdEfGh" },
"amount": "75000",
"currency": "USD",
"period": "monthly"
}

驗證

條件

狀態

訊息

scope.type 不是 "user"

400

scope.type: 尚不支援

scope.user_id 格式不正確

400

scope.user_id: 格式不正確

scope.user_id 不是此組織的成員

400

scope.user_id: 不是此組織的成員

amount 為負數、分數或無效的十進位字串

400

period 不是 "monthly"

400

period: 尚不支援

組織不在企業方案上

400

此端點不支援此組織類型

未啟用使用額度計費

400

此組織未啟用超額計費


4. 移除支出限額

DELETE /v1/organizations/spend_limits/{spend_limit_id}

移除 每位使用者 覆寫,使成員回退到繼承的限額(座位層級、群組或組織預設值)。座位層級、群組和組織層級的列無法透過此端點刪除。

需要範圍:write:spend_limits

路徑參數

欄位

類型

說明

spend_limit_id

字串

前綴為 spl_。必須是每位使用者覆寫的 ID。

回應

{ "type": "spend_limit_deleted", "id": "spl_01RsTuVwXyZaBcDeFgHiJk" }

示例請求

curl -X DELETE "https://api.anthropic.com/v1/organizations/spend_limits/spl_01RsTuVwXyZaBcDeFgHiJk" \
-H "x-api-key: $ANTHROPIC_ADMIN_KEY"

驗證

條件

狀態

訊息

spend_limit_id 在此組織中找不到

404

spend_limit_id 是座位層級、群組或組織列

400

只有按使用者的支出限制可以透過此端點刪除。

組織未採用企業方案

400

此端點不支援此組織類型

未啟用使用額度計費

400

此組織未啟用超額計費


支出限制增加請求

5. 列出增加請求

GET /v1/organizations/spend_limit_increase_requests

列出增加請求,最新的優先。已排除請求者不再是組織成員的請求。

需要範圍:read:spend_limits

查詢參數

欄位

類型

必需

預設

描述

status[]

pendingapproveddenied 中的一個或多個

全部

按狀態篩選。重複參數以輸入多個值。

actor_ids[]

字串

全部

按請求者篩選。接受 user_... ID。

limit

整數 1–1000

20

每頁列數。

page

不透明遊標字串

來自先前回應的 next_page 值。

回應欄位

欄位

類型

描述

data

SpendLimitIncreaseRequest 的陣列

created_at 降序排列。

next_page

字串或 null

下一頁的不透明遊標;當沒有更多頁面時為 null

範例請求

curl "https://api.anthropic.com/v1/organizations/spend_limit_increase_requests?status[]=pending&limit=50" \
-H "x-api-key: $ANTHROPIC_ADMIN_KEY"

範例回應

{
"data": [
{
"type": "spend_limit_increase_request",
"id": "slir_01AbCdEfGhIjKlMnOpQrSt",
"created_at": "2026-05-04T16:22:09Z",
"status": "pending",
"resolved_at": null,
"resolved_by": null,
"actor": {
"type": "user_actor",
"user_id": "user_01AbCdEfGh",
"name": "Jane Smith",
"email_address": "[email protected]"
},
"spend_summary": {
"scope": { "type": "user", "user_id": "user_01AbCdEfGh" },
"amount": "50000",
"currency": "USD",
"period": "monthly",
"source": { "type": "seat_tier", "seat_tier": "enterprise_standard" },
"spend_limit_id": "spl_01XyZaBcDeFgHiJkLmNoPq",
"period_to_date_spend": "48900"
}
}
],
"next_page": null
}

驗證

條件

狀態

訊息

actor_ids[] 項目格式不正確

400

actor_ids[]: 無效的標記使用者 ID

limit 超出 1–1000 範圍

400

page 遊標格式不正確

400

無效的頁面遊標格式無效的頁面遊標

page 遊標與目前的 status[]actor_ids[] 不符

400

頁面遊標與目前的查詢參數不符

來自不同 API 版本的 page 遊標

400

頁面遊標由不同的 API 版本發出;請重新開始分頁

組織不在企業方案上

400

此端點不支援此組織類型

未啟用使用額度計費

400

此組織未啟用超額計費


6. 取得增加請求

GET /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

傳回單一增加請求。

需要範圍:read:spend_limits

路徑參數

欄位

類型

描述

spend_limit_increase_request_id

字串

前綴為 slir_

回應

SpendLimitIncreaseRequest 物件。

範例請求

curl "https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/slir_01AbCdEfGhIjKlMnOpQrSt" \
-H "x-api-key: $ANTHROPIC_ADMIN_KEY"

驗證

條件

狀態

訊息

在此組織中找不到請求

404

請求者不再是此組織的成員

404

組織未採用企業方案

400

此組織類型不支援此端點

未啟用使用額度計費

400

此組織未啟用超額計費


7. 核准增加請求

POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

核准待處理的請求。在 amount 為請求者寫入 每位使用者支出限額,並將請求轉換為 approved。如果請求不包含請求的金額,管理員會在核准時提供新的限額。

需要範圍:write:spend_limits

路徑參數

欄位

類型

說明

spend_limit_increase_request_id

字串

前綴為 slir_

請求本文

欄位

類型

必需

預設值

說明

amount

字串

period 的新每位使用者限額,以最小單位表示,為非負整數十進位字串。

period

字串

"monthly"

請參閱「期間」部分。

suppress_notification

布林值

false

如果為 true,Anthropic 不會寄送電子郵件給該成員通知其請求已核准。

回應

狀態為 approved 的 SpendLimitIncreaseRequest,包含額外的 spend_limit 欄位,其中包含已寫入的 SpendLimit。

範例請求

curl -X POST "https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/slir_01AbCdEfGhIjKlMnOpQrSt/approve" \
-H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
-H "content-type: application/json" \
-d '{"amount": "75000", "suppress_notification": true}'

範例回應

{
"type": "spend_limit_increase_request",
"id": "slir_01AbCdEfGhIjKlMnOpQrSt",
"created_at": "2026-05-04T16:22:09Z",
"status": "approved",
"resolved_at": "2026-05-11T10:05:02Z",
"resolved_by": {
"type": "scoped_api_key_actor",
"scoped_api_key_id": "apikey_01ZyXwVuTsRqPoNmLkJiHg"
},
"actor": {
"type": "user_actor",
"user_id": "user_01AbCdEfGh",
"name": "Jane Smith",
"email_address": "[email protected]"
},
"spend_summary": null,
"spend_limit": {
"type": "spend_limit",
"id": "spl_01RsTuVwXyZaBcDeFgHiJk",
"created_at": "2026-05-11T10:05:02Z",
"updated_at": "2026-05-11T10:05:02Z",
"scope": { "type": "user", "user_id": "user_01AbCdEfGh" },
"amount": "75000",
"currency": "USD",
"period": "monthly"
}
}

驗證

條件

狀態

訊息

在此組織中找不到請求

404

請求者不再是此組織的成員

404

請求已批准拒絕

400

支出限額增加請求已解決

金額為負數、分數或無效的十進制字符串

400

期間不是"monthly"

400

期間:尚不支持

組織未採用企業計劃

400

此端點不支持此組織類型

未啟用使用額度計費

400

此組織未啟用超額計費


8. 拒絕增加請求

POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

拒絕待處理請求。在拒絕時冪等:拒絕已拒絕的請求會返回 200 和現有資源。拒絕已批准的請求會被拒絕,以便自動化可以區分重試和衝突決定。

需要範圍:write:spend_limits

路徑參數

欄位

類型

描述

spend_limit_increase_request_id

字符串

前綴為slir_

請求正文

欄位

類型

必需

預設

描述

suppress_notification

布林值

false

如果true,Anthropic 不會向成員發送電子郵件通知其請求被拒絕。

回應

狀態為拒絕的 SpendLimitIncreaseRequest。

範例請求

curl -X POST "https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/slir_01AbCdEfGhIjKlMnOpQrSt/deny" \
-H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
-H "content-type: application/json" \
-d '{"suppress_notification": true}'

驗證

條件

狀態

訊息

在此組織中找不到請求

404

請求者不再是此組織的成員

404

請求已批准

400

支出限額增加請求已獲批准

請求已 拒絕

— (200, idempotent)

組織未採用企業方案

400

此端點不支援此組織類型

未啟用使用額度

400

此組織未啟用超額計費

是否回答了您的問題?