Claude Platform Docs

Beta

Models
type AnthropicBeta = (string & {}) | "message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 47 more
One of the following:
interface BetaAPIError { type: "api_error"; message }
type: "api_error"
defaultapi_error
message: string
defaultInternal server error
interface BetaAuthenticationError { type: "authentication_error"; message }
type: "authentication_error"
defaultauthentication_error
message: string
defaultAuthentication error
interface BetaBillingError { type: "billing_error"; message }
type: "billing_error"
defaultbilling_error
message: string
defaultBilling error
type BetaCurrency = "USD"
One of the following:
interface BetaErrorResponse { type: "error"; error; request_id }
type: "error"
defaulterror
error: BetaError
One of the following:
request_id: string | null
interface BetaGatewayTimeoutError { type: "timeout_error"; message }
type: "timeout_error"
defaulttimeout_error
message: string
defaultRequest timeout
interface BetaInvalidRequestError { type: "invalid_request_error"; message }
type: "invalid_request_error"
defaultinvalid_request_error
message: string
defaultInvalid request
interface BetaMonetaryAmount { 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: BetaCurrency

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.

interface BetaNotFoundError { type: "not_found_error"; message }
type: "not_found_error"
defaultnot_found_error
message: string
defaultNot found
interface BetaOverloadedError { type: "overloaded_error"; message }
type: "overloaded_error"
defaultoverloaded_error
message: string
defaultOverloaded
interface BetaPermissionError { type: "permission_error"; message }
type: "permission_error"
defaultpermission_error
message: string
defaultPermission denied
interface BetaRateLimitError { type: "rate_limit_error"; message }
type: "rate_limit_error"
defaultrate_limit_error
message: string
defaultRate limited

Beta模型

列出模型
client.beta.models.list(params?, options?): Page<BetaModelInfo>
GET/v1/models

列出可用的模型。

取得模型
client.beta.models.retrieve(modelID, params?, options?): BetaModelInfo
GET/v1/models/{model_id}

取得特定模型。

Beta訊息

建立訊息
client.beta.messages.create(params, options?): BetaMessage | Stream<BetaRawMessageStreamEvent>
POST/v1/messages

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

計算訊息中的 Token 數
client.beta.messages.countTokens(params, options?): BetaMessageTokensCount
POST/v1/messages/count_tokens

計算訊息中的 Token 數量。

Beta訊息批次

建立訊息批次
client.beta.messages.batches.create(params, options?): BetaMessageBatch
POST/v1/messages/batches

傳送一批訊息建立請求。

擷取訊息批次
client.beta.messages.batches.retrieve(messageBatchID, params?, options?): BetaMessageBatch
GET/v1/messages/batches/{message_batch_id}

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

列出訊息批次
client.beta.messages.batches.list(params?, options?): Page<BetaMessageBatch>
GET/v1/messages/batches

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

取消訊息批次
client.beta.messages.batches.cancel(messageBatchID, params?, options?): BetaMessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel

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

刪除訊息批次
client.beta.messages.batches.delete(messageBatchID, params?, options?): BetaDeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}

刪除訊息批次。

擷取訊息批次結果
client.beta.messages.batches.results(messageBatchID, params?, options?): BetaMessageBatchIndividualResponse | Stream<BetaMessageBatchIndividualResponse>
GET/v1/messages/batches/{message_batch_id}/results

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

建立代理程式
client.beta.agents.create(params, options?): BetaManagedAgentsAgent
POST/v1/agents
列出代理程式
client.beta.agents.list(params?, options?): PageCursor<BetaManagedAgentsAgent>
GET/v1/agents
取得代理程式
client.beta.agents.retrieve(agentID, params?, options?): BetaManagedAgentsAgent
GET/v1/agents/{agent_id}
更新代理程式
client.beta.agents.update(agentID, params, options?): BetaManagedAgentsAgent
POST/v1/agents/{agent_id}
封存代理程式
client.beta.agents.archive(agentID, params?, options?): BetaManagedAgentsAgent
POST/v1/agents/{agent_id}/archive

Beta代理程式版本

列出代理程式版本
client.beta.agents.versions.list(agentID, params?, options?): PageCursor<BetaManagedAgentsAgent>
GET/v1/agents/{agent_id}/versions

Beta環境

建立環境
client.beta.environments.create(params, options?): BetaEnvironment
POST/v1/environments

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

列出環境
client.beta.environments.list(params?, options?): PageCursor<BetaEnvironment>
GET/v1/environments

列出環境,支援分頁。

取得環境
client.beta.environments.retrieve(environmentID, params?, options?): BetaEnvironment
GET/v1/environments/{environment_id}

依 ID 擷取特定環境。

更新環境
client.beta.environments.update(environmentID, params, options?): BetaEnvironment
POST/v1/environments/{environment_id}

更新現有環境的設定。

刪除環境
client.beta.environments.delete(environmentID, params?, options?): BetaEnvironmentDeleteResponse
DELETE/v1/environments/{environment_id}

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

封存環境
client.beta.environments.archive(environmentID, params?, options?): BetaEnvironment
POST/v1/environments/{environment_id}/archive

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

Beta環境工作

取得工作項目
client.beta.environments.work.retrieve(workID, params, options?): BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/{work_id}

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

輪詢工作
client.beta.environments.work.poll(environmentID, params?, options?): BetaSelfHostedWork | null
GET/v1/environments/{environment_id}/work/poll

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

確認工作
client.beta.environments.work.ack(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/ack

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

記錄心跳
client.beta.environments.work.heartbeat(workID, params, options?): BetaSelfHostedWorkHeartbeatResponse
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

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

停止工作
client.beta.environments.work.stop(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/stop

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

列出工作項目
client.beta.environments.work.list(environmentID, params?, options?): PageCursor<BetaSelfHostedWork>
GET/v1/environments/{environment_id}/work

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

更新工作項目
client.beta.environments.work.update(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}

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

取得佇列統計資料
client.beta.environments.work.stats(environmentID, params?, options?): BetaSelfHostedWorkQueueStats
GET/v1/environments/{environment_id}/work/stats

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

建立工作階段
client.beta.sessions.create(params, options?): BetaManagedAgentsSession
POST/v1/sessions
列出工作階段
client.beta.sessions.list(params?, options?): BidirectionalPageCursor<BetaManagedAgentsSession>
GET/v1/sessions
取得工作階段
client.beta.sessions.retrieve(sessionID, params?, options?): BetaManagedAgentsSession
GET/v1/sessions/{session_id}
更新工作階段
client.beta.sessions.update(sessionID, params, options?): BetaManagedAgentsSession
POST/v1/sessions/{session_id}
刪除工作階段
client.beta.sessions.delete(sessionID, params?, options?): BetaManagedAgentsDeletedSession
DELETE/v1/sessions/{session_id}
封存工作階段
client.beta.sessions.archive(sessionID, params?, options?): BetaManagedAgentsSession
POST/v1/sessions/{session_id}/archive

Beta工作階段事件

列出事件
client.beta.sessions.events.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/events
傳送事件
client.beta.sessions.events.send(sessionID, params, options?): BetaManagedAgentsSendSessionEvents
POST/v1/sessions/{session_id}/events
串流事件
client.beta.sessions.events.stream(sessionID, params?, options?): BetaManagedAgentsStreamSessionEvents | Stream<BetaManagedAgentsStreamSessionEvents>
GET/v1/sessions/{session_id}/events/stream

Beta工作階段資源

新增工作階段資源
client.beta.sessions.resources.add(sessionID, params, options?): BetaManagedAgentsFileResource
POST/v1/sessions/{session_id}/resources
列出工作階段資源
client.beta.sessions.resources.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionResource>
GET/v1/sessions/{session_id}/resources
取得工作階段資源
client.beta.sessions.resources.retrieve(resourceID, params, options?): ResourceRetrieveResponse
GET/v1/sessions/{session_id}/resources/{resource_id}
更新工作階段資源
client.beta.sessions.resources.update(resourceID, params, options?): ResourceUpdateResponse
POST/v1/sessions/{session_id}/resources/{resource_id}
刪除工作階段資源
client.beta.sessions.resources.delete(resourceID, params, options?): BetaManagedAgentsDeleteSessionResource
DELETE/v1/sessions/{session_id}/resources/{resource_id}

Beta工作階段執行緒

列出工作階段執行緒
client.beta.sessions.threads.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionThread>
GET/v1/sessions/{session_id}/threads
取得工作階段執行緒
client.beta.sessions.threads.retrieve(threadID, params, options?): BetaManagedAgentsSessionThread
GET/v1/sessions/{session_id}/threads/{thread_id}
封存工作階段執行緒
client.beta.sessions.threads.archive(threadID, params, options?): BetaManagedAgentsSessionThread
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

Beta工作階段執行緒事件

列出工作階段執行緒事件
client.beta.sessions.threads.events.list(threadID, params, options?): PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/threads/{thread_id}/events
串流工作階段執行緒事件
client.beta.sessions.threads.events.stream(threadID, params, options?): BetaManagedAgentsStreamSessionThreadEvents | Stream<BetaManagedAgentsStreamSessionThreadEvents>
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

Beta部署

建立部署
client.beta.deployments.create(params, options?): BetaManagedAgentsDeployment
POST/v1/deployments
列出部署
client.beta.deployments.list(params?, options?): PageCursor<BetaManagedAgentsDeployment>
GET/v1/deployments
取得部署
client.beta.deployments.retrieve(deploymentID, params?, options?): BetaManagedAgentsDeployment
GET/v1/deployments/{deployment_id}
更新部署
client.beta.deployments.update(deploymentID, params, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}
封存部署
client.beta.deployments.archive(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/archive
立即執行部署
client.beta.deployments.run(deploymentID, params?, options?): BetaManagedAgentsDeploymentRun
POST/v1/deployments/{deployment_id}/run
暫停部署
client.beta.deployments.pause(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/pause
取消暫停部署
client.beta.deployments.unpause(deploymentID, params?, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/unpause
列出部署執行
client.beta.deploymentRuns.list(params?, options?): PageCursor<BetaManagedAgentsDeploymentRun>
GET/v1/deployment_runs
取得部署執行
client.beta.deploymentRuns.retrieve(deploymentRunID, params?, options?): BetaManagedAgentsDeploymentRun
GET/v1/deployment_runs/{deployment_run_id}

Beta保存庫

建立保存庫
client.beta.vaults.create(params, options?): BetaManagedAgentsVault
POST/v1/vaults
列出保存庫
client.beta.vaults.list(params?, options?): PageCursor<BetaManagedAgentsVault>
GET/v1/vaults
取得保存庫
client.beta.vaults.retrieve(vaultID, params?, options?): BetaManagedAgentsVault
GET/v1/vaults/{vault_id}
更新保存庫
client.beta.vaults.update(vaultID, params, options?): BetaManagedAgentsVault
POST/v1/vaults/{vault_id}
刪除保存庫
client.beta.vaults.delete(vaultID, params?, options?): BetaManagedAgentsDeletedVault
DELETE/v1/vaults/{vault_id}
封存保存庫
client.beta.vaults.archive(vaultID, params?, options?): BetaManagedAgentsVault
POST/v1/vaults/{vault_id}/archive

Beta保存庫憑證

建立憑證
client.beta.vaults.credentials.create(vaultID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials
列出憑證
client.beta.vaults.credentials.list(vaultID, params?, options?): PageCursor<BetaManagedAgentsCredential>
GET/v1/vaults/{vault_id}/credentials
取得憑證
client.beta.vaults.credentials.retrieve(credentialID, params, options?): BetaManagedAgentsCredential
GET/v1/vaults/{vault_id}/credentials/{credential_id}
更新憑證
client.beta.vaults.credentials.update(credentialID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}
刪除憑證
client.beta.vaults.credentials.delete(credentialID, params, options?): BetaManagedAgentsDeletedCredential
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
封存憑證
client.beta.vaults.credentials.archive(credentialID, params, options?): BetaManagedAgentsCredential
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
驗證憑證
client.beta.vaults.credentials.mcpOAuthValidate(credentialID, params, options?): BetaManagedAgentsCredentialValidation
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate
建立記憶儲存區
client.beta.memoryStores.create(params, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores
列出記憶儲存區
client.beta.memoryStores.list(params?, options?): PageCursor<BetaManagedAgentsMemoryStore>
GET/v1/memory_stores
擷取記憶儲存區
client.beta.memoryStores.retrieve(memoryStoreID, params?, options?): BetaManagedAgentsMemoryStore
GET/v1/memory_stores/{memory_store_id}
更新記憶儲存區
client.beta.memoryStores.update(memoryStoreID, params, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}
刪除記憶儲存區
client.beta.memoryStores.delete(memoryStoreID, params?, options?): BetaManagedAgentsDeletedMemoryStore
DELETE/v1/memory_stores/{memory_store_id}
封存記憶儲存區
client.beta.memoryStores.archive(memoryStoreID, params?, options?): BetaManagedAgentsMemoryStore
POST/v1/memory_stores/{memory_store_id}/archive

Beta記憶儲存區記憶

建立記憶
client.beta.memoryStores.memories.create(memoryStoreID, params, options?): BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories
列出記憶
client.beta.memoryStores.memories.list(memoryStoreID, params?, options?): PageCursor<BetaManagedAgentsMemoryListItem>
GET/v1/memory_stores/{memory_store_id}/memories
擷取記憶
client.beta.memoryStores.memories.retrieve(memoryID, params, options?): BetaManagedAgentsMemory
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
更新記憶
client.beta.memoryStores.memories.update(memoryID, params, options?): BetaManagedAgentsMemory
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
刪除記憶
client.beta.memoryStores.memories.delete(memoryID, params, options?): BetaManagedAgentsDeletedMemory
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

Beta記憶儲存區記憶版本

列出記憶版本
client.beta.memoryStores.memoryVersions.list(memoryStoreID, params?, options?): PageCursor<BetaManagedAgentsMemoryVersion>
GET/v1/memory_stores/{memory_store_id}/memory_versions
擷取記憶版本
client.beta.memoryStores.memoryVersions.retrieve(memoryVersionID, params, options?): BetaManagedAgentsMemoryVersion
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
塗銷記憶版本
client.beta.memoryStores.memoryVersions.redact(memoryVersionID, params, options?): BetaManagedAgentsMemoryVersion
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

Beta檔案

上傳檔案
client.beta.files.upload(params, options?): BetaFileMetadata
POST/v1/files
列出檔案
client.beta.files.list(params?, options?): PageCursor<BetaFileMetadata>
GET/v1/files
下載檔案
client.beta.files.download(fileID, params?, options?): Response
GET/v1/files/{file_id}/content
取得檔案中繼資料
client.beta.files.retrieveMetadata(fileID, params?, options?): BetaFileMetadata
GET/v1/files/{file_id}
刪除檔案
client.beta.files.delete(fileID, params?, options?): BetaDeletedFile
DELETE/v1/files/{file_id}

Beta技能

建立技能
client.beta.skills.create(params, options?): BetaSkill
POST/v1/skills
列出技能
client.beta.skills.list(params?, options?): PageCursor<BetaSkill>
GET/v1/skills
取得技能
client.beta.skills.retrieve(skillID, params?, options?): BetaSkill
GET/v1/skills/{skill_id}
刪除技能
client.beta.skills.delete(skillID, params?, options?): BetaDeletedSkill
DELETE/v1/skills/{skill_id}

Beta技能版本

建立技能版本
client.beta.skills.versions.create(skillID, params, options?): BetaSkillVersion
POST/v1/skills/{skill_id}/versions
列出技能版本
client.beta.skills.versions.list(skillID, params?, options?): PageCursor<BetaSkillVersion>
GET/v1/skills/{skill_id}/versions
下載技能版本內容
client.beta.skills.versions.download(version, params, options?): Response
GET/v1/skills/{skill_id}/versions/{version}/content

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

取得技能版本
client.beta.skills.versions.retrieve(version, params, options?): BetaSkillVersion
GET/v1/skills/{skill_id}/versions/{version}
刪除技能版本
client.beta.skills.versions.delete(version, params, options?): BetaDeletedSkillVersion
DELETE/v1/skills/{skill_id}/versions/{version}
建立使用者設定檔
client.beta.userProfiles.create(params, options?): BetaUserProfile
POST/v1/user_profiles
列出使用者設定檔
client.beta.userProfiles.list(params?, options?): PageCursor<BetaUserProfile>
GET/v1/user_profiles
取得使用者設定檔
client.beta.userProfiles.retrieve(userProfileID, params?, options?): BetaUserProfile
GET/v1/user_profiles/{user_profile_id}
更新使用者設定檔
client.beta.userProfiles.update(userProfileID, params, options?): BetaUserProfile
POST/v1/user_profiles/{user_profile_id}
建立註冊 URL
client.beta.userProfiles.createEnrollmentURL(userProfileID, params?, options?): BetaUserProfileEnrollmentURL
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDream

建立 Dream
client.beta.dreams.create(params, options?): BetaDream
POST/v1/dreams

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

列出 Dream
client.beta.dreams.list(params?, options?): PageCursor<BetaDream>
GET/v1/dreams

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

取得 Dream
client.beta.dreams.retrieve(dreamID, params?, options?): BetaDream
GET/v1/dreams/{dream_id}

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

取消 Dream
client.beta.dreams.cancel(dreamID, params?, options?): BetaDream
POST/v1/dreams/{dream_id}/cancel

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

封存 Dream
client.beta.dreams.archive(dreamID, params?, options?): BetaDream
POST/v1/dreams/{dream_id}/archive

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

Beta通道

建立通道
client.beta.tunnels.create(params, options?): BetaTunnel
POST/v1/tunnels

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

取得通道
client.beta.tunnels.retrieve(tunnelID, params?, options?): BetaTunnel
GET/v1/tunnels/{tunnel_id}

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

列出通道
client.beta.tunnels.list(params?, options?): PageCursor<BetaTunnel>
GET/v1/tunnels

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

封存通道
client.beta.tunnels.archive(tunnelID, params?, options?): BetaTunnel
POST/v1/tunnels/{tunnel_id}/archive

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

顯示通道權杖
client.beta.tunnels.revealToken(tunnelID, params?, options?): BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/reveal_token

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

輪替通道權杖
client.beta.tunnels.rotateToken(tunnelID, params, options?): BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/rotate_token

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

Beta通道憑證

建立通道憑證
client.beta.tunnels.certificates.create(tunnelID, params, options?): BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates

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

取得通道憑證
client.beta.tunnels.certificates.retrieve(certificateID, params, options?): BetaTunnelCertificate
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

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

列出通道憑證
client.beta.tunnels.certificates.list(tunnelID, params?, options?): PageCursor<BetaTunnelCertificate>
GET/v1/tunnels/{tunnel_id}/certificates

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

封存通道憑證
client.beta.tunnels.certificates.archive(certificateID, params, options?): BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

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

Beta組織

取得目前組織
client.beta.organization.retrieve(options?): BetaOrganization
GET/v1/organizations/me

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

Beta組織API 金鑰

列出 API 金鑰
client.beta.organization.apiKeys.list(query?, options?): Page<BetaAPIKey>
GET/v1/organizations/api_keys
擷取 API 金鑰(Admin API)
client.beta.organization.apiKeys.retrieve(apiKeyID, options?): BetaAPIKey
GET/v1/organizations/api_keys/{api_key_id}

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

更新 API 金鑰
client.beta.organization.apiKeys.update(apiKeyID, body, options?): BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}

Beta組織外部金鑰

建立外部金鑰
client.beta.organization.externalKeys.create(body, options?): BetaExternalKey
POST/v1/organizations/external_keys

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

列出外部金鑰
client.beta.organization.externalKeys.list(query?, options?): PageCursor<BetaExternalKey>
GET/v1/organizations/external_keys

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

取得外部金鑰
client.beta.organization.externalKeys.retrieve(externalKeyID, options?): BetaExternalKey
GET/v1/organizations/external_keys/{external_key_id}

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

更新外部金鑰
client.beta.organization.externalKeys.update(externalKeyID, body, options?): BetaExternalKey
POST/v1/organizations/external_keys/{external_key_id}

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

刪除外部金鑰
client.beta.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

刪除外部金鑰設定。

驗證外部金鑰
client.beta.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

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

Beta組織聯合簽發者

建立聯合簽發者
client.beta.organization.federation.issuers.create(params, options?): BetaFederationIssuer
POST/v1/organizations/federation_issuers

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

列出聯合簽發者
client.beta.organization.federation.issuers.list(params?, options?): PageCursor<BetaFederationIssuer>
GET/v1/organizations/federation_issuers

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

取得聯合簽發者
client.beta.organization.federation.issuers.retrieve(federationIssuerID, params?, options?): BetaFederationIssuer
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。

更新聯合簽發者
client.beta.organization.federation.issuers.update(federationIssuerID, params, options?): BetaFederationIssuer
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。

封存聯合簽發者
client.beta.organization.federation.issuers.archive(federationIssuerID, params?, options?): BetaFederationIssuer
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組織聯合規則

建立聯合規則
client.beta.organization.federation.rules.create(params, options?): BetaFederationRule
POST/v1/organizations/federation_rules

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

列出聯合規則
client.beta.organization.federation.rules.list(params?, options?): PageCursor<BetaFederationRule>
GET/v1/organizations/federation_rules

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

取得聯合規則
client.beta.organization.federation.rules.retrieve(federationRuleID, params?, options?): BetaFederationRule
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。

更新聯合規則
client.beta.organization.federation.rules.update(federationRuleID, params, options?): BetaFederationRule
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。

封存聯合規則
client.beta.organization.federation.rules.archive(federationRuleID, params?, options?): BetaFederationRule
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組織聯合規則工作區

新增聯合規則工作區
client.beta.organization.federation.rules.workspaces.add(federationRuleID, params, options?): BetaFederationRuleWorkspace
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。

列出聯合規則工作區
client.beta.organization.federation.rules.workspaces.list(federationRuleID, params?, options?): PageCursor<BetaFederationRuleWorkspace>
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。

移除聯合規則工作區
client.beta.organization.federation.rules.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
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組織邀請

建立邀請
client.beta.organization.invites.create(body, options?): BetaOrganizationInvite
POST/v1/organizations/invites

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

列出邀請
client.beta.organization.invites.list(query?, options?): Page<BetaOrganizationInvite>
GET/v1/organizations/invites

列出組織的邀請。

取得邀請
client.beta.organization.invites.retrieve(inviteID, options?): BetaOrganizationInvite
GET/v1/organizations/invites/{invite_id}

依 ID 擷取邀請。

刪除邀請
client.beta.organization.invites.delete(inviteID, options?): InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

刪除待處理的邀請。

Beta組織服務帳戶

建立服務帳戶
client.beta.organization.serviceAccounts.create(params, options?): BetaServiceAccount
POST/v1/organizations/service_accounts

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

列出服務帳戶
client.beta.organization.serviceAccounts.list(params?, options?): PageCursor<BetaServiceAccount>
GET/v1/organizations/service_accounts

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

取得服務帳戶
client.beta.organization.serviceAccounts.retrieve(serviceAccountID, params?, options?): BetaServiceAccount
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。

更新服務帳戶
client.beta.organization.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccount
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。

封存服務帳戶
client.beta.organization.serviceAccounts.archive(serviceAccountID, params?, options?): BetaServiceAccount
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組織服務帳戶工作區

將工作區新增至服務帳戶
client.beta.organization.serviceAccounts.workspaces.add(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
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。

列出服務帳戶的工作區
client.beta.organization.serviceAccounts.workspaces.list(serviceAccountID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>
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。

從服務帳戶移除工作區
client.beta.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
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組織使用者

列出使用者
client.beta.organization.users.list(query?, options?): Page<BetaOrganizationUser>
GET/v1/organizations/users

列出組織的成員。

取得使用者
client.beta.organization.users.retrieve(userID, options?): BetaOrganizationUser
GET/v1/organizations/users/{user_id}

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

更新使用者
client.beta.organization.users.update(userID, body, options?): BetaOrganizationUser
POST/v1/organizations/users/{user_id}

更新成員的組織角色。

移除使用者
client.beta.organization.users.remove(userID, options?): UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

從組織中移除成員。

Beta組織工作區

列出工作區
client.beta.organization.workspaces.list(query?, options?): Page<BetaWorkspace>
GET/v1/organizations/workspaces
建立工作區
client.beta.organization.workspaces.create(params, options?): BetaWorkspace
POST/v1/organizations/workspaces
取得工作區
client.beta.organization.workspaces.retrieve(workspaceID, options?): BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
更新工作區
client.beta.organization.workspaces.update(workspaceID, body, options?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
封存工作區
client.beta.organization.workspaces.archive(workspaceID, options?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}/archive

Beta組織工作區速率限制

列出工作區速率限制
client.beta.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<BetaWorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

列出工作區的速率限制。

Beta組織工作區成員

列出工作區成員
client.beta.organization.workspaces.members.list(workspaceID, query?, options?): Page<BetaWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
建立工作區成員
client.beta.organization.workspaces.members.add(workspaceID, body, options?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
取得工作區成員
client.beta.organization.workspaces.members.retrieve(userID, params, options?): BetaWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作區成員
client.beta.organization.workspaces.members.update(userID, params, options?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
刪除工作區成員
client.beta.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Beta組織工作區服務帳戶

列出服務帳戶工作區成員
client.beta.organization.workspaces.serviceAccounts.list(workspaceID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>
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。

建立服務帳戶工作區成員
client.beta.organization.workspaces.serviceAccounts.add(workspaceID, params, options?): BetaServiceAccountWorkspaceMember
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。

取得服務帳戶工作區成員
client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
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。

更新服務帳戶工作區成員
client.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember
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。

刪除服務帳戶工作區成員
client.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): ServiceAccountRemoveResponse
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組織速率限制

列出組織速率限制
client.beta.organization.rateLimits.list(query?, options?): PageCursor<BetaOrganizationRateLimit>
GET/v1/organizations/rate_limits

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

Beta組織合規設定

取得合規設定
client.beta.organization.complianceSettings.retrieve(options?): BetaComplianceSettings
GET/v1/organizations/compliance_settings

擷取您組織的合規設定。

更新合規設定
client.beta.organization.complianceSettings.update(body, options?): BetaComplianceSettings
POST/v1/organizations/compliance_settings

更新您組織的合規設定。

Beta組織分析摘要

取得活動摘要
client.beta.organization.analytics.summaries.list(query, options?): PageCursor<BetaAnalyticsSingleDayActivitySummary>
GET/v1/organizations/analytics/summaries

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

Beta組織分析使用者

列出使用者活動
client.beta.organization.analytics.users.list(query?, options?): PageCursor<BetaAnalyticsUserActivity>
GET/v1/organizations/analytics/users

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

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

取得聊天專案用量
client.beta.organization.analytics.apps.chat.projects.list(query?, options?): PageCursor<BetaAnalyticsProjectActivity>
GET/v1/organizations/analytics/apps/chat/projects

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

Beta組織分析連接器

取得連接器使用量
client.beta.organization.analytics.connectors.list(query?, options?): PageCursor<BetaAnalyticsConnectorActivity>
GET/v1/organizations/analytics/connectors

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

Beta組織分析外掛程式

取得外掛程式使用量
client.beta.organization.analytics.plugins.list(query?, options?): PageCursor<BetaAnalyticsPluginActivity>
GET/v1/organizations/analytics/plugins

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

Beta組織分析技能

取得技能使用量
client.beta.organization.analytics.skills.list(query?, options?): PageCursor<BetaAnalyticsSkillActivity>
GET/v1/organizations/analytics/skills

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

Beta組織分析Artifacts

取得 Artifact 活動
client.beta.organization.analytics.artifacts.list(query, options?): PageCursor<BetaAnalyticsArtifactActivity>
GET/v1/organizations/analytics/artifacts

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

Beta組織分析使用量報告

取得隨時間變化的 Token 用量
client.beta.organization.analytics.usageReport.list(query, options?): PageCursor<BetaAnalyticsUsageReportTimeBucket>
GET/v1/organizations/analytics/usage_report

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

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

取得每位使用者的 Token 用量
client.beta.organization.analytics.userUsageReport.list(query, options?): PageCursor<BetaAnalyticsUsageUsersItem>
GET/v1/organizations/analytics/user_usage_report

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

Beta組織分析成本報告

取得隨時間變化的成本
client.beta.organization.analytics.costReport.list(query, options?): PageCursor<BetaAnalyticsCostReportTimeBucket>
GET/v1/organizations/analytics/cost_report

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

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

取得每位使用者的成本
client.beta.organization.analytics.userCostReport.list(query, options?): PageCursor<BetaAnalyticsCostUsersItem>
GET/v1/organizations/analytics/user_cost_report

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

Beta組織支出限制

設定支出限制
client.beta.organization.spendLimits.set(params, options?): BetaSpendLimit
POST/v1/organizations/spend_limits

設定支出限制。

取得支出限制
client.beta.organization.spendLimits.retrieve(spendLimitID, options?): BetaSpendLimit
GET/v1/organizations/spend_limits/{spend_limit_id}

依 ID 擷取支出限制。

刪除支出限制
client.beta.organization.spendLimits.delete(spendLimitID, options?): SpendLimitDeleteResponse
DELETE/v1/organizations/spend_limits/{spend_limit_id}

刪除支出限制。

列出支出限制
client.beta.organization.spendLimits.list(params?, options?): PageCursor<BetaSpendLimit>
GET/v1/organizations/spend_limits

列出組織的支出限制。

Beta組織支出限制有效

列出有效支出限制
client.beta.organization.spendLimits.effective.list(query?, options?): PageCursor<BetaSpendSummary>
GET/v1/organizations/spend_limits/effective

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

Beta組織支出限制提高請求

列出支出限制提高請求
client.beta.organization.spendLimits.increaseRequests.list(query?, options?): PageCursor<BetaSpendLimitIncreaseRequest>
GET/v1/organizations/spend_limit_increase_requests

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

取得支出限制提高請求
client.beta.organization.spendLimits.increaseRequests.retrieve(spendLimitIncreaseRequestID, options?): BetaSpendLimitIncreaseRequest
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

擷取支出限制提高請求。

核准支出限制提高請求
client.beta.organization.spendLimits.increaseRequests.approve(spendLimitIncreaseRequestID, body, options?): IncreaseRequestApproveResponse
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

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

拒絕支出限制提高請求
client.beta.organization.spendLimits.increaseRequests.deny(spendLimitIncreaseRequestID, body, options?): BetaSpendLimitIncreaseRequest
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

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

Beta組織RBAC 群組

建立 RBAC 群組
client.beta.organization.rbacGroups.create(body, options?): BetaRBACGroup
POST/v1/organizations/rbac_groups

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

列出 RBAC 群組
client.beta.organization.rbacGroups.list(query?, options?): PageCursor<BetaRBACGroup>
GET/v1/organizations/rbac_groups

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

取得 RBAC 群組
client.beta.organization.rbacGroups.retrieve(rbacGroupID, options?): BetaRBACGroup
GET/v1/organizations/rbac_groups/{rbac_group_id}

依 ID 擷取 RBAC 群組。

更新 RBAC 群組
client.beta.organization.rbacGroups.update(rbacGroupID, body, options?): BetaRBACGroup
POST/v1/organizations/rbac_groups/{rbac_group_id}

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

刪除 RBAC 群組
client.beta.organization.rbacGroups.delete(rbacGroupID, options?): RBACGroupDeleteResponse
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

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

Beta組織RBAC 群組成員

列出 RBAC 群組成員
client.beta.organization.rbacGroups.members.list(rbacGroupID, query?, options?): PageCursor<BetaRBACGroupMember>
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

列出 RBAC 群組的成員。

新增 RBAC 群組成員
client.beta.organization.rbacGroups.members.add(rbacGroupID, body, options?): BetaRBACGroupMember
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

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

移除 RBAC 群組成員
client.beta.organization.rbacGroups.members.remove(userID, params, options?): MemberRemoveResponse
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

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

Beta組織RBAC 角色

列出 RBAC 角色
client.beta.organization.rbacRoles.list(query?, options?): PageCursor<BetaRBACRole>
GET/v1/organizations/rbac_roles

列出組織中的 RBAC 角色。

取得 RBAC 角色
client.beta.organization.rbacRoles.retrieve(rbacRoleID, options?): BetaRBACRole
GET/v1/organizations/rbac_roles/{rbac_role_id}

依 ID 擷取 RBAC 角色。

Beta組織RBAC 角色權限

列出 RBAC 角色權限
client.beta.organization.rbacRoles.permissions.list(rbacRoleID, query?, options?): PageCursor<BetaRBACRolePermission>
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

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

Beta組織外掛程式

建立外掛程式
client.beta.organization.plugins.create(params, options?): BetaPlugin
POST/v1/organizations/plugins

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

取得外掛程式
client.beta.organization.plugins.retrieve(pluginID, params?, options?): BetaPlugin
GET/v1/organizations/plugins/{plugin_id}

依 ID 擷取外掛程式。

更新外掛程式
client.beta.organization.plugins.update(pluginID, params, options?): BetaPlugin
POST/v1/organizations/plugins/{plugin_id}

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

列出 Plugin
client.beta.organization.plugins.list(params?, options?): PageCursor<BetaPlugin>
GET/v1/organizations/plugins

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

刪除 Plugin
client.beta.organization.plugins.delete(pluginID, params?, options?): BetaDeletedPlugin
DELETE/v1/organizations/plugins/{plugin_id}

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

Beta組織外掛程式版本

建立 Plugin 版本
client.beta.organization.plugins.versions.create(pluginID, params, options?): BetaPluginVersion
POST/v1/organizations/plugins/{plugin_id}/versions

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

列出 Plugin 版本
client.beta.organization.plugins.versions.list(pluginID, params?, options?): PageCursor<BetaPluginVersion>
GET/v1/organizations/plugins/{plugin_id}/versions

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

取得 Plugin 版本
client.beta.organization.plugins.versions.retrieve(version, params, options?): BetaPluginVersion
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

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

下載 Plugin 版本封存檔
client.beta.organization.plugins.versions.download(version, params, options?): Response
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

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

Beta組織外掛程式安裝設定

列出 Plugin 安裝設定
client.beta.organization.plugins.installationSettings.list(pluginID, params?, options?): PageCursor<BetaPluginInstallationSetting>
GET/v1/organizations/plugins/{plugin_id}/installation_settings

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

設定 Plugin 安裝設定
client.beta.organization.plugins.installationSettings.set(target, params, options?): BetaPluginInstallationSetting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

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

移除 Plugin 安裝設定
client.beta.organization.plugins.installationSettings.remove(target, params, options?): BetaDeletedPluginInstallationSetting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

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

Beta組織外掛程式分享

列出 Plugin 分享
client.beta.organization.plugins.shares.list(pluginID, params?, options?): PageCursor<BetaPluginShare>
GET/v1/organizations/plugins/{plugin_id}/shares

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

Beta組織外掛程式市集

列出外掛程式市集
client.beta.organization.pluginMarketplaces.list(params?, options?): PageCursor<BetaPluginMarketplace>
GET/v1/organizations/plugin_marketplaces

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

取得外掛程式市集
client.beta.organization.pluginMarketplaces.retrieve(marketplaceID, params?, options?): BetaPluginMarketplace
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

依 ID 擷取外掛程式市集。

更新外掛程式市集
client.beta.organization.pluginMarketplaces.update(marketplaceID, params, options?): BetaPluginMarketplace
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

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

驗證外掛程式市集儲存庫
client.beta.organization.pluginMarketplaces.validateRepository(params, options?): BetaPluginMarketplaceValidationReport
POST/v1/organizations/plugin_marketplaces/validate_repository

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

驗證外掛程式市集封存檔
client.beta.organization.pluginMarketplaces.validateArchive(params, options?): BetaPluginMarketplaceValidationReport
POST/v1/organizations/plugin_marketplaces/validate_archive

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