Claude Platform Docs

Beta

Models
beta_api_error: object{ type: "api_error", message }
type: "api_error"
message: string
beta_authentication_error: object{ type: "authentication_error", message }
type: "authentication_error"
message: string
beta_billing_error: object{ type: "billing_error", message }
type: "billing_error"
message: string
beta_currency: "USD"
"USD"
beta_error_response: object{ type: "error", error, request_id }
beta_gateway_timeout_error: object{ type: "timeout_error", message }
type: "timeout_error"
message: string
beta_invalid_request_error: object{ type: "invalid_request_error", message }
type: "invalid_request_error"
message: string
beta_monetary_amount: object{ amount, currency }

A monetary amount in a specific currency.

amount: string

Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

currency: "USD"

Uppercase ISO-4217 currency code. USD is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

beta_not_found_error: object{ type: "not_found_error", message }
type: "not_found_error"
message: string
beta_overloaded_error: object{ type: "overloaded_error", message }
type: "overloaded_error"
message: string
beta_permission_error: object{ type: "permission_error", message }
type: "permission_error"
message: string
beta_rate_limit_error: object{ type: "rate_limit_error", message }
type: "rate_limit_error"
message: string

Beta模型

列出模型
$ ant beta:models list
GET/v1/models

列出可用的模型。

取得模型
$ ant beta:models retrieve
GET/v1/models/{model_id}

取得特定模型。

Beta訊息

建立訊息
$ ant beta:messages create
POST/v1/messages

傳送包含文字和／或圖片內容的結構化輸入訊息清單，模型將產生對話中的下一則訊息。

計算訊息中的 Token 數
$ ant beta:messages count-tokens
POST/v1/messages/count_tokens

計算訊息中的 Token 數量。

Beta訊息批次

建立訊息批次
$ ant beta:messages:batches create
POST/v1/messages/batches

傳送一批訊息建立請求。

擷取訊息批次
$ ant beta:messages:batches retrieve
GET/v1/messages/batches/{message_batch_id}

此端點具冪等性，可用於輪詢訊息批次是否完成。若要存取訊息批次的結果，請對回應中的 results_url 欄位發出請求。

列出訊息批次
$ ant beta:messages:batches list
GET/v1/messages/batches

列出工作區內的所有訊息批次。最近建立的批次會優先傳回。

取消訊息批次
$ ant beta:messages:batches cancel
POST/v1/messages/batches/{message_batch_id}/cancel

批次可在處理結束前隨時取消。一旦啟動取消，批次便會進入 canceling 狀態，此時系統可能會先完成任何進行中且不可中斷的請求，然後才完成取消。

刪除訊息批次
$ ant beta:messages:batches delete
DELETE/v1/messages/batches/{message_batch_id}

刪除訊息批次。

擷取訊息批次結果
$ ant beta:messages:batches results
GET/v1/messages/batches/{message_batch_id}/results

以 .jsonl 檔案的形式串流傳輸訊息批次的結果。

Beta代理程式

建立代理程式
$ ant beta:agents create
POST/v1/agents
列出代理程式
$ ant beta:agents list
GET/v1/agents
取得代理程式
$ ant beta:agents retrieve
GET/v1/agents/{agent_id}
更新代理程式
$ ant beta:agents update
POST/v1/agents/{agent_id}
封存代理程式
$ ant beta:agents archive
POST/v1/agents/{agent_id}/archive

Beta代理程式版本

列出代理程式版本
$ ant beta:agents:versions list
GET/v1/agents/{agent_id}/versions

Beta環境

建立環境
$ ant beta:environments create
POST/v1/environments

使用指定的設定建立新環境。

列出環境
$ ant beta:environments list
GET/v1/environments

列出環境，支援分頁。

取得環境
$ ant beta:environments retrieve
GET/v1/environments/{environment_id}

依 ID 擷取特定環境。

更新環境
$ ant beta:environments update
POST/v1/environments/{environment_id}

更新現有環境的設定。

刪除環境
$ ant beta:environments delete
DELETE/v1/environments/{environment_id}

依 ID 刪除環境。傳回刪除確認。

封存環境
$ ant beta:environments archive
POST/v1/environments/{environment_id}/archive

依 ID 封存環境。已封存的環境無法用於建立新的工作階段。

Beta環境工作

取得工作項目
$ ant beta:environments:work retrieve
GET/v1/environments/{environment_id}/work/{work_id}

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

輪詢工作
$ ant beta:environments:work poll
GET/v1/environments/{environment_id}/work/poll

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

確認工作
$ ant beta:environments:work ack
POST/v1/environments/{environment_id}/work/{work_id}/ack

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

記錄心跳
$ ant beta:environments:work heartbeat
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

停止工作
$ ant beta:environments:work stop
POST/v1/environments/{environment_id}/work/{work_id}/stop

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

列出工作項目
$ ant beta:environments:work list
GET/v1/environments/{environment_id}/work

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

更新工作項目
$ ant beta:environments:work update
POST/v1/environments/{environment_id}/work/{work_id}

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

取得佇列統計資料
$ ant beta:environments:work stats
GET/v1/environments/{environment_id}/work/stats

取得環境工作佇列的統計資料。

Beta工作階段

建立工作階段
$ ant beta:sessions create
POST/v1/sessions
列出工作階段
$ ant beta:sessions list
GET/v1/sessions
取得工作階段
$ ant beta:sessions retrieve
GET/v1/sessions/{session_id}
更新工作階段
$ ant beta:sessions update
POST/v1/sessions/{session_id}
刪除工作階段
$ ant beta:sessions delete
DELETE/v1/sessions/{session_id}
封存工作階段
$ ant beta:sessions archive
POST/v1/sessions/{session_id}/archive

Beta工作階段事件

列出事件
$ ant beta:sessions:events list
GET/v1/sessions/{session_id}/events
傳送事件
$ ant beta:sessions:events send
POST/v1/sessions/{session_id}/events
串流事件
$ ant beta:sessions:events stream
GET/v1/sessions/{session_id}/events/stream

Beta工作階段資源

新增工作階段資源
$ ant beta:sessions:resources add
POST/v1/sessions/{session_id}/resources
列出工作階段資源
$ ant beta:sessions:resources list
GET/v1/sessions/{session_id}/resources
取得工作階段資源
$ ant beta:sessions:resources retrieve
GET/v1/sessions/{session_id}/resources/{resource_id}
更新工作階段資源
$ ant beta:sessions:resources update
POST/v1/sessions/{session_id}/resources/{resource_id}
刪除工作階段資源
$ ant beta:sessions:resources delete
DELETE/v1/sessions/{session_id}/resources/{resource_id}

Beta工作階段執行緒

列出工作階段執行緒
$ ant beta:sessions:threads list
GET/v1/sessions/{session_id}/threads
取得工作階段執行緒
$ ant beta:sessions:threads retrieve
GET/v1/sessions/{session_id}/threads/{thread_id}
封存工作階段執行緒
$ ant beta:sessions:threads archive
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

Beta工作階段執行緒事件

列出工作階段執行緒事件
$ ant beta:sessions:threads:events list
GET/v1/sessions/{session_id}/threads/{thread_id}/events
串流工作階段執行緒事件
$ ant beta:sessions:threads:events stream
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

Beta部署

建立部署
$ ant beta:deployments create
POST/v1/deployments
列出部署
$ ant beta:deployments list
GET/v1/deployments
取得部署
$ ant beta:deployments retrieve
GET/v1/deployments/{deployment_id}
更新部署
$ ant beta:deployments update
POST/v1/deployments/{deployment_id}
封存部署
$ ant beta:deployments archive
POST/v1/deployments/{deployment_id}/archive
立即執行部署
$ ant beta:deployments run
POST/v1/deployments/{deployment_id}/run
暫停部署
$ ant beta:deployments pause
POST/v1/deployments/{deployment_id}/pause
取消暫停部署
$ ant beta:deployments unpause
POST/v1/deployments/{deployment_id}/unpause

Beta部署執行

列出部署執行
$ ant beta:deployment-runs list
GET/v1/deployment_runs
取得部署執行
$ ant beta:deployment-runs retrieve
GET/v1/deployment_runs/{deployment_run_id}

Beta保存庫

Create a Vault
$ ant beta:vaults create
POST/v1/vaults
列出保存庫
$ ant beta:vaults list
GET/v1/vaults
Retrieve a Vault
$ ant beta:vaults retrieve
GET/v1/vaults/{vault_id}
Update a Vault
$ ant beta:vaults update
POST/v1/vaults/{vault_id}
Delete a Vault
$ ant beta:vaults delete
DELETE/v1/vaults/{vault_id}
Archive a Vault
$ ant beta:vaults archive
POST/v1/vaults/{vault_id}/archive

Beta保存庫憑證

Create a Credential
$ ant beta:vaults:credentials create
POST/v1/vaults/{vault_id}/credentials
列出憑證
$ ant beta:vaults:credentials list
GET/v1/vaults/{vault_id}/credentials
Retrieve a Credential
$ ant beta:vaults:credentials retrieve
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update a Credential
$ ant beta:vaults:credentials update
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete a Credential
$ ant beta:vaults:credentials delete
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive a Credential
$ ant beta:vaults:credentials archive
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate an MCP OAuth Credential
$ ant beta:vaults:credentials mcp-oauth-validate
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

Beta記憶儲存區

建立記憶儲存區
$ ant beta:memory-stores create
POST/v1/memory_stores
列出記憶儲存區
$ ant beta:memory-stores list
GET/v1/memory_stores
擷取記憶儲存區
$ ant beta:memory-stores retrieve
GET/v1/memory_stores/{memory_store_id}
更新記憶儲存區
$ ant beta:memory-stores update
POST/v1/memory_stores/{memory_store_id}
刪除記憶儲存區
$ ant beta:memory-stores delete
DELETE/v1/memory_stores/{memory_store_id}
封存記憶儲存區
$ ant beta:memory-stores archive
POST/v1/memory_stores/{memory_store_id}/archive

Beta記憶儲存區記憶

建立記憶
$ ant beta:memory-stores:memories create
POST/v1/memory_stores/{memory_store_id}/memories
列出記憶
$ ant beta:memory-stores:memories list
GET/v1/memory_stores/{memory_store_id}/memories
擷取記憶
$ ant beta:memory-stores:memories retrieve
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
更新記憶
$ ant beta:memory-stores:memories update
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
刪除記憶
$ ant beta:memory-stores:memories delete
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

Beta記憶儲存區記憶版本

列出記憶版本
$ ant beta:memory-stores:memory-versions list
GET/v1/memory_stores/{memory_store_id}/memory_versions
擷取記憶版本
$ ant beta:memory-stores:memory-versions retrieve
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
塗銷記憶版本
$ ant beta:memory-stores:memory-versions redact
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

Beta檔案

上傳檔案
$ ant beta:files upload
POST/v1/files
列出檔案
$ ant beta:files list
GET/v1/files
下載檔案
$ ant beta:files download
GET/v1/files/{file_id}/content
取得檔案中繼資料
$ ant beta:files retrieve-metadata
GET/v1/files/{file_id}
刪除檔案
$ ant beta:files delete
DELETE/v1/files/{file_id}

Beta技能

建立技能
$ ant beta:skills create
POST/v1/skills
列出技能
$ ant beta:skills list
GET/v1/skills
取得技能
$ ant beta:skills retrieve
GET/v1/skills/{skill_id}
刪除技能
$ ant beta:skills delete
DELETE/v1/skills/{skill_id}

Beta技能版本

建立技能版本
$ ant beta:skills:versions create
POST/v1/skills/{skill_id}/versions
列出技能版本
$ ant beta:skills:versions list
GET/v1/skills/{skill_id}/versions
下載技能版本內容
$ ant beta:skills:versions download
GET/v1/skills/{skill_id}/versions/{version}/content

以 zip 壓縮檔形式下載技能版本的內容。

取得技能版本
$ ant beta:skills:versions retrieve
GET/v1/skills/{skill_id}/versions/{version}
刪除技能版本
$ ant beta:skills:versions delete
DELETE/v1/skills/{skill_id}/versions/{version}

Beta使用者設定檔

建立使用者設定檔
$ ant beta:user-profiles create
POST/v1/user_profiles
列出使用者設定檔
$ ant beta:user-profiles list
GET/v1/user_profiles
取得使用者設定檔
$ ant beta:user-profiles retrieve
GET/v1/user_profiles/{user_profile_id}
更新使用者設定檔
$ ant beta:user-profiles update
POST/v1/user_profiles/{user_profile_id}
建立註冊 URL
$ ant beta:user-profiles create-enrollment-url
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDream

建立 Dream
$ ant beta:dreams create
POST/v1/dreams

啟動一個非同步工作，利用過去的工作階段產生記憶儲存區的重新組織版本，並取回 dream 以輪詢結果。

列出 Dream
$ ant beta:dreams list
GET/v1/dreams

列出工作區中的 dream，最新的在前。

取得 Dream
$ ant beta:dreams retrieve
GET/v1/dreams/{dream_id}

依 ID 取得 dream，以檢查其狀態、輸出記憶儲存區及權杖用量。

取消 Dream
$ ant beta:dreams cancel
POST/v1/dreams/{dream_id}/cancel

停止處於 pending 或 running 狀態的 dream。

封存 Dream
$ ant beta:dreams archive
POST/v1/dreams/{dream_id}/archive

將 completed、failed 或 canceled 的 dream 從預設的 dream 清單中隱藏。

Beta通道

建立通道
$ ant beta:tunnels create
POST/v1/tunnels

Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭，且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點，這些端點在遷移期間內仍可使用。

取得通道
$ ant beta:tunnels retrieve
GET/v1/tunnels/{tunnel_id}

Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭，且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點，這些端點在遷移期間內仍可使用。

列出通道
$ ant beta:tunnels list
GET/v1/tunnels

Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭，且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點，這些端點在遷移期間內仍可使用。

封存通道
$ ant beta:tunnels archive
POST/v1/tunnels/{tunnel_id}/archive

Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭，且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點，這些端點在遷移期間內仍可使用。

顯示通道權杖
$ ant beta:tunnels reveal-token
POST/v1/tunnels/{tunnel_id}/reveal_token

Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭，且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點，這些端點在遷移期間內仍可使用。

輪替通道權杖
$ ant beta:tunnels rotate-token
POST/v1/tunnels/{tunnel_id}/rotate_token

Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭，且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點，這些端點在遷移期間內仍可使用。

Beta通道憑證

建立通道憑證
$ ant beta:tunnels:certificates create
POST/v1/tunnels/{tunnel_id}/certificates

Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭，且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點，這些端點在遷移期間內仍可使用。

取得通道憑證
$ ant beta:tunnels:certificates retrieve
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭，且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點，這些端點在遷移期間內仍可使用。

列出通道憑證
$ ant beta:tunnels:certificates list
GET/v1/tunnels/{tunnel_id}/certificates

Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭，且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點，這些端點在遷移期間內仍可使用。

封存通道憑證
$ ant beta:tunnels:certificates archive
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭，且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點，這些端點在遷移期間內仍可使用。

Beta組織

取得目前組織
$ ant beta:organization retrieve
GET/v1/organizations/me

擷取與已驗證 API 金鑰相關聯之組織的資訊。

Beta組織API 金鑰

列出 API 金鑰
$ ant beta:organization:api-keys list
GET/v1/organizations/api_keys
擷取 API 金鑰（Admin API）
$ ant beta:organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}

依 ID 查詢並擷取您組織中單一 API 金鑰的資訊。此 Admin API 端點需要 Admin API 金鑰，適用於以程式方式管理金鑰，且絕不會傳回金鑰的秘密值。若要檢視或建立您自己的 API 金鑰，請前往 Claude Console 中的 API 金鑰。

更新 API 金鑰
$ ant beta:organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

Beta組織外部金鑰

建立外部金鑰
$ ant beta:organization:external-keys create
POST/v1/organizations/external_keys

建立由呼叫者組織擁有的外部金鑰設定。

列出外部金鑰
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys

列出呼叫者組織中的外部金鑰設定。

取得外部金鑰
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}

依 ID 擷取呼叫者組織中的單一外部金鑰設定。

更新外部金鑰
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}

部分更新外部金鑰設定。省略的欄位將保持不變。

刪除外部金鑰
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}

刪除外部金鑰設定。

驗證外部金鑰
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

針對客戶的 KMS 驗證外部金鑰設定。

Beta組織聯合簽發者

建立聯合簽發者
$ ant beta:organization:federation:issuers create
POST/v1/organizations/federation_issuers

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

列出聯合簽發者
$ ant beta:organization:federation:issuers list
GET/v1/organizations/federation_issuers

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

取得聯合簽發者
$ ant beta:organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

更新聯合簽發者
$ ant beta:organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

封存聯合簽發者
$ ant beta:organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

Beta組織聯合規則

建立聯合規則
$ ant beta:organization:federation:rules create
POST/v1/organizations/federation_rules

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

列出聯合規則
$ ant beta:organization:federation:rules list
GET/v1/organizations/federation_rules

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

取得聯合規則
$ ant beta:organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

更新聯合規則
$ ant beta:organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

封存聯合規則
$ ant beta:organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

Beta組織聯合規則工作區

新增聯合規則工作區
$ ant beta:organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

列出聯合規則工作區
$ ant beta:organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

移除聯合規則工作區
$ ant beta:organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

Beta組織邀請

建立邀請
$ ant beta:organization:invites create
POST/v1/organizations/invites

透過電子郵件邀請使用者加入組織。

列出邀請
$ ant beta:organization:invites list
GET/v1/organizations/invites

列出組織的邀請。

取得邀請
$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}

依 ID 擷取邀請。

刪除邀請
$ ant beta:organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

刪除待處理的邀請。

Beta組織服務帳戶

建立服務帳戶
$ ant beta:organization:service-accounts create
POST/v1/organizations/service_accounts

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

列出服務帳戶
$ ant beta:organization:service-accounts list
GET/v1/organizations/service_accounts

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

取得服務帳戶
$ ant beta:organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

更新服務帳戶
$ ant beta:organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

封存服務帳戶
$ ant beta:organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

Beta組織服務帳戶工作區

將工作區新增至服務帳戶
$ ant beta:organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

列出服務帳戶的工作區
$ ant beta:organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

從服務帳戶移除工作區
$ ant beta:organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

Beta組織使用者

列出使用者
$ ant beta:organization:users list
GET/v1/organizations/users

列出組織的成員。

取得使用者
$ ant beta:organization:users retrieve
GET/v1/organizations/users/{user_id}

依使用者 ID 擷取組織成員。

更新使用者
$ ant beta:organization:users update
POST/v1/organizations/users/{user_id}

更新成員的組織角色。

移除使用者
$ ant beta:organization:users remove
DELETE/v1/organizations/users/{user_id}

從組織中移除成員。

Beta組織工作區

列出工作區
$ ant beta:organization:workspaces list
GET/v1/organizations/workspaces
建立工作區
$ ant beta:organization:workspaces create
POST/v1/organizations/workspaces
取得工作區
$ ant beta:organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
更新工作區
$ ant beta:organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
封存工作區
$ ant beta:organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

Beta組織工作區速率限制

列出工作區速率限制
$ ant beta:organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

列出工作區的速率限制。

Beta組織工作區成員

列出工作區成員
$ ant beta:organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
建立工作區成員
$ ant beta:organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
取得工作區成員
$ ant beta:organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作區成員
$ ant beta:organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
刪除工作區成員
$ ant beta:organization:workspaces:members remove
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Beta組織工作區服務帳戶

列出服務帳戶工作區成員
$ ant beta:organization:workspaces:service-accounts list
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

建立服務帳戶工作區成員
$ ant beta:organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

取得服務帳戶工作區成員
$ ant beta:organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

更新服務帳戶工作區成員
$ ant beta:organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合（workload identity federation）規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

刪除服務帳戶工作區成員
$ ant beta:organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

Beta組織速率限制

列出組織速率限制
$ ant beta:organization:rate-limits list
GET/v1/organizations/rate_limits

列出您組織的 Messages API 速率限制。

Beta組織合規設定

取得合規設定
$ ant beta:organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings

擷取您組織的合規設定。

更新合規設定
$ ant beta:organization:compliance-settings update
POST/v1/organizations/compliance_settings

更新您組織的合規設定。

Beta組織分析摘要

取得活動摘要
$ ant beta:organization:analytics:summaries list
GET/v1/organizations/analytics/summaries

取得指定日期範圍內的全組織活動摘要。

Beta組織分析使用者

列出使用者活動
$ ant beta:organization:analytics:users list
GET/v1/organizations/analytics/users

取得指定日期的每位使用者活動，採用游標式分頁。

Beta組織分析應用程式聊天專案

取得聊天專案用量
$ ant beta:organization:analytics:apps:chat:projects list
GET/v1/organizations/analytics/apps/chat/projects

取得指定日期的每個專案活動，並支援以游標為基礎的分頁。

Beta組織分析連接器

取得連接器使用量
$ ant beta:organization:analytics:connectors list
GET/v1/organizations/analytics/connectors

取得指定日期的每個連接器用量，採用游標式分頁。

Beta組織分析外掛程式

取得外掛程式使用量
$ ant beta:organization:analytics:plugins list
GET/v1/organizations/analytics/plugins

取得指定日期的每個外掛程式安裝與呼叫用量，採用分頁。

Beta組織分析技能

取得技能使用量
$ ant beta:organization:analytics:skills list
GET/v1/organizations/analytics/skills

取得指定日期的每項技能用量，採用游標式分頁。

Beta組織分析Artifacts

取得 Artifact 活動
$ ant beta:organization:analytics:artifacts list
GET/v1/organizations/analytics/artifacts

取得指定日期的 artifact 建立活動，依 MIME 類型細分。

Beta組織分析使用量報告

取得隨時間變化的 Token 用量
$ ant beta:organization:analytics:usage-report list
GET/v1/organizations/analytics/usage_report

取得某個日期範圍內隨時間變化的 token 用量。

Beta組織分析使用者用量報告

取得每位使用者的 Token 用量
$ ant beta:organization:analytics:user-usage-report list
GET/v1/organizations/analytics/user_usage_report

取得某個日期範圍內每位使用者的 token 用量。

Beta組織分析成本報告

取得隨時間變化的成本
$ ant beta:organization:analytics:cost-report list
GET/v1/organizations/analytics/cost_report

取得某個日期範圍內隨時間變化的成本（以美元計）。

Beta組織分析使用者成本報告

取得每位使用者的成本
$ ant beta:organization:analytics:user-cost-report list
GET/v1/organizations/analytics/user_cost_report

取得某個日期範圍內每位使用者的成本（以美元計）。

Beta組織支出限制

設定支出限制
$ ant beta:organization:spend-limits set
POST/v1/organizations/spend_limits

設定支出限制。

取得支出限制
$ ant beta:organization:spend-limits retrieve
GET/v1/organizations/spend_limits/{spend_limit_id}

依 ID 擷取支出限制。

刪除支出限制
$ ant beta:organization:spend-limits delete
DELETE/v1/organizations/spend_limits/{spend_limit_id}

刪除支出限制。

列出支出限制
$ ant beta:organization:spend-limits list
GET/v1/organizations/spend_limits

列出組織的支出限制。

Beta組織支出限制有效

列出有效支出限制
$ ant beta:organization:spend-limits:effective list
GET/v1/organizations/spend_limits/effective

列出每位成員的有效支出限制及本期至今的支出。

Beta組織支出限制提高請求

列出支出限制提高請求
$ ant beta:organization:spend-limits:increase-requests list
GET/v1/organizations/spend_limit_increase_requests

列出支出限制提高請求，最新的在前。

取得支出限制提高請求
$ ant beta:organization:spend-limits:increase-requests retrieve
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

擷取支出限制提高請求。

核准支出限制提高請求
$ ant beta:organization:spend-limits:increase-requests approve
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

核准待處理的支出限制提高請求。

拒絕支出限制提高請求
$ ant beta:organization:spend-limits:increase-requests deny
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

拒絕待處理的支出限制提高請求。

Beta組織RBAC 群組

建立 RBAC 群組
$ ant beta:organization:rbac-groups create
POST/v1/organizations/rbac_groups

在 Claude Enterprise 租戶中建立 RBAC 群組。透過 API 建立的群組其來源類型為 "direct"。

列出 RBAC 群組
$ ant beta:organization:rbac-groups list
GET/v1/organizations/rbac_groups

列出 Claude Enterprise 租戶中的 RBAC 群組。

取得 RBAC 群組
$ ant beta:organization:rbac-groups retrieve
GET/v1/organizations/rbac_groups/{rbac_group_id}

依 ID 擷取 RBAC 群組。

更新 RBAC 群組
$ ant beta:organization:rbac-groups update
POST/v1/organizations/rbac_groups/{rbac_group_id}

更新 RBAC 群組的名稱。當租用戶中的組織使用 SCIM 佈建時，由身分識別提供者佈建的群組（來源類型為 "scim"）無法透過 API 修改。

刪除 RBAC 群組
$ ant beta:organization:rbac-groups delete
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

刪除 RBAC 群組。當租用戶中的組織使用 SCIM 佈建時，由身分識別提供者佈建的群組（來源類型為 "scim"）無法透過 API 刪除。

Beta組織RBAC 群組成員

列出 RBAC 群組成員
$ ant beta:organization:rbac-groups:members list
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

列出 RBAC 群組的成員。

新增 RBAC 群組成員
$ ant beta:organization:rbac-groups:members add
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

將使用者新增至 RBAC 群組。當租用戶中的組織使用 SCIM 佈建時，由身分識別提供者佈建的群組（來源類型為 "scim"）其成員資格無法透過 API 修改。

移除 RBAC 群組成員
$ ant beta:organization:rbac-groups:members remove
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

從 RBAC 群組中移除使用者。當租用戶中的組織使用 SCIM 佈建時，由身分識別提供者佈建的群組（來源類型為 "scim"）其成員資格無法透過 API 修改。

Beta組織RBAC 角色

列出 RBAC 角色
$ ant beta:organization:rbac-roles list
GET/v1/organizations/rbac_roles

列出組織中的 RBAC 角色。

取得 RBAC 角色
$ ant beta:organization:rbac-roles retrieve
GET/v1/organizations/rbac_roles/{rbac_role_id}

依 ID 擷取 RBAC 角色。

Beta組織RBAC 角色權限

列出 RBAC 角色權限
$ ant beta:organization:rbac-roles:permissions list
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

列出 RBAC 角色所授予的權限。

Beta組織外掛程式

建立外掛程式
$ ant beta:organization:plugins create
POST/v1/organizations/plugins

上傳版本的檔案，以建立組織擁有的外掛程式（Plugin）及其 第一個版本。

取得外掛程式
$ ant beta:organization:plugins retrieve
GET/v1/organizations/plugins/{plugin_id}

依 ID 擷取外掛程式。

更新外掛程式
$ ant beta:organization:plugins update
POST/v1/organizations/plugins/{plugin_id}

變更向成員提供的組織擁有 Plugin 的已儲存版本，例如回復到較早的版本。這會釘選所提供的版本：之後上傳的版本仍會儲存，但不再改變所提供的內容，且目前無法取消釘選，無論在此處或在 claude.ai 中皆然。

列出 Plugin
$ ant beta:organization:plugins list
GET/v1/organizations/plugins

列出在組織下建立的 Plugin，依最新優先排序：包括組織自有外掛程式市集中的 Plugin，以及成員個人外掛程式市集中的 Plugin。

刪除 Plugin
$ ant beta:organization:plugins delete
DELETE/v1/organizations/plugins/{plugin_id}

永久刪除 Plugin 及其所有版本，效果與管理員在 claude.ai 中刪除時完全相同。該 Plugin 可以屬於組織或成員，包括已離開組織的成員。

Beta組織外掛程式版本

建立 Plugin 版本
$ ant beta:organization:plugins:versions create
POST/v1/organizations/plugins/{plugin_id}/versions

透過上傳新版本的檔案，為組織擁有的 Plugin 新增版本；除非該 Plugin 所提供的版本已被釘選，否則新版本會成為向成員提供的版本。

列出 Plugin 版本
$ ant beta:organization:plugins:versions list
GET/v1/organizations/plugins/{plugin_id}/versions

列出 Plugin 的版本，依最新優先排序。

取得 Plugin 版本
$ ant beta:organization:plugins:versions retrieve
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

依 ID 擷取 Plugin 的某個版本，或擷取 Plugin 的最新版本。

下載 Plugin 版本封存檔
$ ant beta:organization:plugins:versions download
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

下載某個版本的 .zip 封存檔，內容與儲存時完全相同。每次從成員個人外掛程式市集下載 Plugin，都會記錄在 Compliance API 活動摘要中。

Beta組織外掛程式安裝設定

列出 Plugin 安裝設定
$ ant beta:organization:plugins:installation-settings list
GET/v1/organizations/plugins/{plugin_id}/installation_settings

列出組織擁有的 Plugin 的安裝設定（用於指定該 Plugin 適用於哪些成員），依建立時間由新到舊排序。

設定 Plugin 安裝設定
$ ant beta:organization:plugins:installation-settings set
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

為整個組織或單一 RBAC 群組設定或變更組織擁有的 Plugin 的安裝設定。

移除 Plugin 安裝設定
$ ant beta:organization:plugins:installation-settings remove
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

移除組織擁有的 Plugin 針對整個組織或單一 RBAC 群組本身的安裝設定。

Beta組織外掛程式分享

列出 Plugin 分享
$ ant beta:organization:plugins:shares list
GET/v1/organizations/plugins/{plugin_id}/shares

列出成員擁有的 Plugin 的擁有者所提供的分享（分享給組織的所有成員、某個 RBAC 群組或單一成員），依授予時間由新到舊排序。

Beta組織外掛程式市集

列出外掛程式市集
$ ant beta:organization:plugin-marketplaces list
GET/v1/organizations/plugin_marketplaces

列出 Plugin 所在的外掛程式市集，依最新優先排序：包括組織自有的市集及其成員的個人市集。

取得外掛程式市集
$ ant beta:organization:plugin-marketplaces retrieve
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

依 ID 擷取外掛程式市集。

更新外掛程式市集
$ ant beta:organization:plugin-marketplaces update
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

設定組織自有外掛程式市集之一的預設安裝設定。該市集中每個沒有自身設定的 Plugin（包括之後新增的 Plugin）都會以此預設值作為其全組織設定。

驗證外掛程式市集儲存庫
$ ant beta:organization:plugin-marketplaces validate-repository
POST/v1/organizations/plugin_marketplaces/validate_repository

檢查存放於公開 GitHub 儲存庫中的外掛程式市集是否能同步至 claude.ai，而不會連接或儲存該市集。

驗證外掛程式市集封存檔
$ ant beta:organization:plugin-marketplaces validate-archive
POST/v1/organizations/plugin_marketplaces/validate_archive

檢查以市集目錄 .zip 形式上傳的外掛程式市集是否能同步至 claude.ai，而不會連接或儲存該市集。

Beta組織遙測目的地

建立遙測目的地
$ ant beta:organization:telemetry-destinations create
POST/v1/organizations/telemetry_destinations

為組織註冊 OpenTelemetry 目的地。

列出遙測目的地
$ ant beta:organization:telemetry-destinations list
GET/v1/organizations/telemetry_destinations

列出組織的目的地，最新的排在最前面，可選擇僅列出涵蓋指定工作區的目的地。

擷取遙測目的地
$ ant beta:organization:telemetry-destinations retrieve
GET/v1/organizations/telemetry_destinations/{destination_id}

讀取目的地的設定、狀態及最近的傳遞結果。

更新遙測目的地
$ ant beta:organization:telemetry-destinations update
POST/v1/organizations/telemetry_destinations/{destination_id}

變更遙測目的地的設定、狀態或其涵蓋的工作區。

刪除遙測目的地
$ ant beta:organization:telemetry-destinations delete
DELETE/v1/organizations/telemetry_destinations/{destination_id}

刪除目的地及其工作區清單。

測試遙測目的地
$ ant beta:organization:telemetry-destinations test
POST/v1/organizations/telemetry_destinations/{destination_id}/test

將一個名為 anthropic.test 的測試 span 連同已註冊的標頭傳送至目的地，僅傳送一次且不重試，並回報目的地的回應。無論目的地是否以 2xx 狀態回應，回應皆為 200：其 result 的類型為 success，或類型為 failure 並在 error 中附上原因。目的地的設定、state 與 delivery_health 不會變更。已停用的目的地也可以測試。對同一目的地的兩次測試之間請等待 10 秒；過早送出的請求可能會收到狀態 429。

Beta組織遙測目的地工作區

列出遙測目的地工作區
$ ant beta:organization:telemetry-destinations:workspaces list
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces

列出目的地工作區清單中的工作區，最新的項目排在最前面。

新增遙測目的地工作區
$ ant beta:organization:telemetry-destinations:workspaces add
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

將一個工作區新增至目的地的工作區清單。

移除遙測目的地工作區
$ ant beta:organization:telemetry-destinations:workspaces remove
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

從目的地的工作區清單中移除一個工作區。