Beta
Models
Beta模型
取得模型
client.beta.models.retrieve(modelID, params?, options?): BetaModelInfo取得特定模型。
Beta訊息
建立訊息
client.beta.messages.create(params, options?): BetaMessage | Stream<BetaRawMessageStreamEvent>傳送包含文字和/或圖片內容的結構化輸入訊息清單,模型將產生對話中的下一則訊息。
計算訊息中的 Token 數
client.beta.messages.countTokens(params, options?): BetaMessageTokensCount計算訊息中的 Token 數量。
Beta訊息批次
建立訊息批次
client.beta.messages.batches.create(params, options?): BetaMessageBatch傳送一批訊息建立請求。
擷取訊息批次
client.beta.messages.batches.retrieve(messageBatchID, params?, options?): BetaMessageBatch此端點具冪等性,可用於輪詢訊息批次是否完成。若要存取訊息批次的結果,請對回應中的 results_url 欄位發出請求。
列出訊息批次
client.beta.messages.batches.list(params?, options?): Page<BetaMessageBatch>列出工作區內的所有訊息批次。最近建立的批次會優先傳回。
取消訊息批次
client.beta.messages.batches.cancel(messageBatchID, params?, options?): BetaMessageBatch批次可在處理結束前隨時取消。一旦啟動取消,批次便會進入 canceling 狀態,此時系統可能會先完成任何進行中且不可中斷的請求,然後才完成取消。
刪除訊息批次
client.beta.messages.batches.delete(messageBatchID, params?, options?): BetaDeletedMessageBatch刪除訊息批次。
擷取訊息批次結果
client.beta.messages.batches.results(messageBatchID, params?, options?): BetaMessageBatchIndividualResponse | Stream<BetaMessageBatchIndividualResponse>以 .jsonl 檔案的形式串流傳輸訊息批次的結果。
Beta代理程式
取得代理程式
client.beta.agents.retrieve(agentID, params?, options?): BetaManagedAgentsAgent更新代理程式
client.beta.agents.update(agentID, params, options?): BetaManagedAgentsAgent封存代理程式
client.beta.agents.archive(agentID, params?, options?): BetaManagedAgentsAgentBeta代理程式版本
列出代理程式版本
client.beta.agents.versions.list(agentID, params?, options?): PageCursor<BetaManagedAgentsAgent>Beta環境
建立環境
client.beta.environments.create(params, options?): BetaEnvironment使用指定的設定建立新環境。
列出環境
client.beta.environments.list(params?, options?): PageCursor<BetaEnvironment>列出環境,支援分頁。
取得環境
client.beta.environments.retrieve(environmentID, params?, options?): BetaEnvironment依 ID 擷取特定環境。
更新環境
client.beta.environments.update(environmentID, params, options?): BetaEnvironment更新現有環境的設定。
刪除環境
client.beta.environments.delete(environmentID, params?, options?): BetaEnvironmentDeleteResponse依 ID 刪除環境。傳回刪除確認。
封存環境
client.beta.environments.archive(environmentID, params?, options?): BetaEnvironment依 ID 封存環境。已封存的環境無法用於建立新的工作階段。
Beta環境工作
取得工作項目
client.beta.environments.work.retrieve(workID, params, options?): BetaSelfHostedWork注意:這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫,用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考;您無需直接呼叫它們。
輪詢工作
client.beta.environments.work.poll(environmentID, params?, options?): BetaSelfHostedWork | null注意:這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫,用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考;您無需直接呼叫它們。
確認工作
client.beta.environments.work.ack(workID, params, options?): BetaSelfHostedWork注意:這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫,用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考;您無需直接呼叫它們。
記錄心跳
client.beta.environments.work.heartbeat(workID, params, options?): BetaSelfHostedWorkHeartbeatResponse注意:這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫,用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考;您無需直接呼叫它們。
停止工作
client.beta.environments.work.stop(workID, params, options?): BetaSelfHostedWork注意:這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫,用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考;您無需直接呼叫它們。
列出工作項目
client.beta.environments.work.list(environmentID, params?, options?): PageCursor<BetaSelfHostedWork>注意:這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫,用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考;您無需直接呼叫它們。
更新工作項目
client.beta.environments.work.update(workID, params, options?): BetaSelfHostedWork注意:這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫,用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考;您無需直接呼叫它們。
取得佇列統計資料
client.beta.environments.work.stats(environmentID, params?, options?): BetaSelfHostedWorkQueueStats取得環境工作佇列的統計資料。
Beta工作階段
列出工作階段
client.beta.sessions.list(params?, options?): BidirectionalPageCursor<BetaManagedAgentsSession>取得工作階段
client.beta.sessions.retrieve(sessionID, params?, options?): BetaManagedAgentsSession更新工作階段
client.beta.sessions.update(sessionID, params, options?): BetaManagedAgentsSession刪除工作階段
client.beta.sessions.delete(sessionID, params?, options?): BetaManagedAgentsDeletedSession封存工作階段
client.beta.sessions.archive(sessionID, params?, options?): BetaManagedAgentsSessionBeta工作階段事件
列出事件
client.beta.sessions.events.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionEvent>傳送事件
client.beta.sessions.events.send(sessionID, params, options?): BetaManagedAgentsSendSessionEvents串流事件
client.beta.sessions.events.stream(sessionID, params?, options?): BetaManagedAgentsStreamSessionEvents | Stream<BetaManagedAgentsStreamSessionEvents>Beta工作階段資源
新增工作階段資源
client.beta.sessions.resources.add(sessionID, params, options?): BetaManagedAgentsFileResource列出工作階段資源
client.beta.sessions.resources.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionResource>取得工作階段資源
client.beta.sessions.resources.retrieve(resourceID, params, options?): ResourceRetrieveResponse更新工作階段資源
client.beta.sessions.resources.update(resourceID, params, options?): ResourceUpdateResponse刪除工作階段資源
client.beta.sessions.resources.delete(resourceID, params, options?): BetaManagedAgentsDeleteSessionResourceBeta工作階段執行緒
列出工作階段執行緒
client.beta.sessions.threads.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionThread>取得工作階段執行緒
client.beta.sessions.threads.retrieve(threadID, params, options?): BetaManagedAgentsSessionThread封存工作階段執行緒
client.beta.sessions.threads.archive(threadID, params, options?): BetaManagedAgentsSessionThreadBeta工作階段執行緒事件
列出工作階段執行緒事件
client.beta.sessions.threads.events.list(threadID, params, options?): PageCursor<BetaManagedAgentsSessionEvent>串流工作階段執行緒事件
client.beta.sessions.threads.events.stream(threadID, params, options?): BetaManagedAgentsStreamSessionThreadEvents | Stream<BetaManagedAgentsStreamSessionThreadEvents>Beta部署
建立部署
client.beta.deployments.create(params, options?): BetaManagedAgentsDeployment列出部署
client.beta.deployments.list(params?, options?): PageCursor<BetaManagedAgentsDeployment>取得部署
client.beta.deployments.retrieve(deploymentID, params?, options?): BetaManagedAgentsDeployment更新部署
client.beta.deployments.update(deploymentID, params, options?): BetaManagedAgentsDeployment封存部署
client.beta.deployments.archive(deploymentID, params?, options?): BetaManagedAgentsDeployment立即執行部署
client.beta.deployments.run(deploymentID, params?, options?): BetaManagedAgentsDeploymentRun暫停部署
client.beta.deployments.pause(deploymentID, params?, options?): BetaManagedAgentsDeployment取消暫停部署
client.beta.deployments.unpause(deploymentID, params?, options?): BetaManagedAgentsDeploymentBeta部署執行
列出部署執行
client.beta.deploymentRuns.list(params?, options?): PageCursor<BetaManagedAgentsDeploymentRun>取得部署執行
client.beta.deploymentRuns.retrieve(deploymentRunID, params?, options?): BetaManagedAgentsDeploymentRunBeta保存庫
取得保存庫
client.beta.vaults.retrieve(vaultID, params?, options?): BetaManagedAgentsVault更新保存庫
client.beta.vaults.update(vaultID, params, options?): BetaManagedAgentsVault刪除保存庫
client.beta.vaults.delete(vaultID, params?, options?): BetaManagedAgentsDeletedVault封存保存庫
client.beta.vaults.archive(vaultID, params?, options?): BetaManagedAgentsVaultBeta保存庫憑證
建立憑證
client.beta.vaults.credentials.create(vaultID, params, options?): BetaManagedAgentsCredential列出憑證
client.beta.vaults.credentials.list(vaultID, params?, options?): PageCursor<BetaManagedAgentsCredential>取得憑證
client.beta.vaults.credentials.retrieve(credentialID, params, options?): BetaManagedAgentsCredential更新憑證
client.beta.vaults.credentials.update(credentialID, params, options?): BetaManagedAgentsCredential刪除憑證
client.beta.vaults.credentials.delete(credentialID, params, options?): BetaManagedAgentsDeletedCredential封存憑證
client.beta.vaults.credentials.archive(credentialID, params, options?): BetaManagedAgentsCredential驗證憑證
client.beta.vaults.credentials.mcpOAuthValidate(credentialID, params, options?): BetaManagedAgentsCredentialValidationBeta記憶儲存區
建立記憶儲存區
client.beta.memoryStores.create(params, options?): BetaManagedAgentsMemoryStore列出記憶儲存區
client.beta.memoryStores.list(params?, options?): PageCursor<BetaManagedAgentsMemoryStore>擷取記憶儲存區
client.beta.memoryStores.retrieve(memoryStoreID, params?, options?): BetaManagedAgentsMemoryStore更新記憶儲存區
client.beta.memoryStores.update(memoryStoreID, params, options?): BetaManagedAgentsMemoryStore刪除記憶儲存區
client.beta.memoryStores.delete(memoryStoreID, params?, options?): BetaManagedAgentsDeletedMemoryStore封存記憶儲存區
client.beta.memoryStores.archive(memoryStoreID, params?, options?): BetaManagedAgentsMemoryStoreBeta記憶儲存區記憶
建立記憶
client.beta.memoryStores.memories.create(memoryStoreID, params, options?): BetaManagedAgentsMemory列出記憶
client.beta.memoryStores.memories.list(memoryStoreID, params?, options?): PageCursor<BetaManagedAgentsMemoryListItem>擷取記憶
client.beta.memoryStores.memories.retrieve(memoryID, params, options?): BetaManagedAgentsMemory更新記憶
client.beta.memoryStores.memories.update(memoryID, params, options?): BetaManagedAgentsMemory刪除記憶
client.beta.memoryStores.memories.delete(memoryID, params, options?): BetaManagedAgentsDeletedMemoryBeta記憶儲存區記憶版本
列出記憶版本
client.beta.memoryStores.memoryVersions.list(memoryStoreID, params?, options?): PageCursor<BetaManagedAgentsMemoryVersion>擷取記憶版本
client.beta.memoryStores.memoryVersions.retrieve(memoryVersionID, params, options?): BetaManagedAgentsMemoryVersion塗銷記憶版本
client.beta.memoryStores.memoryVersions.redact(memoryVersionID, params, options?): BetaManagedAgentsMemoryVersionBeta檔案
取得檔案中繼資料
client.beta.files.retrieveMetadata(fileID, params?, options?): BetaFileMetadataBeta技能
刪除技能
client.beta.skills.delete(skillID, params?, options?): BetaDeletedSkillBeta技能版本
建立技能版本
client.beta.skills.versions.create(skillID, params, options?): BetaSkillVersion列出技能版本
client.beta.skills.versions.list(skillID, params?, options?): PageCursor<BetaSkillVersion>下載技能版本內容
client.beta.skills.versions.download(version, params, options?): Response以 zip 壓縮檔形式下載技能版本的內容。
取得技能版本
client.beta.skills.versions.retrieve(version, params, options?): BetaSkillVersion刪除技能版本
client.beta.skills.versions.delete(version, params, options?): BetaDeletedSkillVersionBeta使用者設定檔
列出使用者設定檔
client.beta.userProfiles.list(params?, options?): PageCursor<BetaUserProfile>取得使用者設定檔
client.beta.userProfiles.retrieve(userProfileID, params?, options?): BetaUserProfile更新使用者設定檔
client.beta.userProfiles.update(userProfileID, params, options?): BetaUserProfile建立註冊 URL
client.beta.userProfiles.createEnrollmentURL(userProfileID, params?, options?): BetaUserProfileEnrollmentURLBetaDream
Beta通道
建立通道
client.beta.tunnels.create(params, options?): BetaTunnelTunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭,且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點,這些端點在遷移期間內仍可使用。
取得通道
client.beta.tunnels.retrieve(tunnelID, params?, options?): BetaTunnelTunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭,且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點,這些端點在遷移期間內仍可使用。
列出通道
client.beta.tunnels.list(params?, options?): PageCursor<BetaTunnel>Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭,且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點,這些端點在遷移期間內仍可使用。
封存通道
client.beta.tunnels.archive(tunnelID, params?, options?): BetaTunnelTunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭,且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點,這些端點在遷移期間內仍可使用。
顯示通道權杖
client.beta.tunnels.revealToken(tunnelID, params?, options?): BetaTunnelTokenTunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭,且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點,這些端點在遷移期間內仍可使用。
輪替通道權杖
client.beta.tunnels.rotateToken(tunnelID, params, options?): BetaTunnelTokenTunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭,且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點,這些端點在遷移期間內仍可使用。
Beta通道憑證
建立通道憑證
client.beta.tunnels.certificates.create(tunnelID, params, options?): BetaTunnelCertificateTunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭,且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點,這些端點在遷移期間內仍可使用。
取得通道憑證
client.beta.tunnels.certificates.retrieve(certificateID, params, options?): BetaTunnelCertificateTunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭,且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點,這些端點在遷移期間內仍可使用。
列出通道憑證
client.beta.tunnels.certificates.list(tunnelID, params?, options?): PageCursor<BetaTunnelCertificate>Tunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭,且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點,這些端點在遷移期間內仍可使用。
封存通道憑證
client.beta.tunnels.certificates.archive(certificateID, params, options?): BetaTunnelCertificateTunnels API 目前為研究預覽版。它需要 anthropic-beta: mcp-tunnels-2026-06-22 標頭,且可能在沒有棄用期的情況下變更。它取代了位於 /v1/organizations/tunnels 的 Admin API 端點,這些端點在遷移期間內仍可使用。
Beta組織
取得目前組織
client.beta.organization.retrieve(options?): BetaOrganization擷取與已驗證 API 金鑰相關聯之組織的資訊。
Beta組織API 金鑰
列出 API 金鑰
client.beta.organization.apiKeys.list(query?, options?): Page<BetaAPIKey>擷取 API 金鑰(Admin API)
client.beta.organization.apiKeys.retrieve(apiKeyID, options?): BetaAPIKey依 ID 查詢並擷取您組織中單一 API 金鑰的資訊。此 Admin API 端點需要 Admin API 金鑰,適用於以程式方式管理金鑰,且絕不會傳回金鑰的秘密值。若要檢視或建立您自己的 API 金鑰,請前往 Claude Console 中的 API 金鑰。
更新 API 金鑰
client.beta.organization.apiKeys.update(apiKeyID, body, options?): BetaAPIKeyBeta組織外部金鑰
建立外部金鑰
client.beta.organization.externalKeys.create(body, options?): BetaExternalKey建立由呼叫者組織擁有的外部金鑰設定。
列出外部金鑰
client.beta.organization.externalKeys.list(query?, options?): PageCursor<BetaExternalKey>列出呼叫者組織中的外部金鑰設定。
取得外部金鑰
client.beta.organization.externalKeys.retrieve(externalKeyID, options?): BetaExternalKey依 ID 擷取呼叫者組織中的單一外部金鑰設定。
更新外部金鑰
client.beta.organization.externalKeys.update(externalKeyID, body, options?): BetaExternalKey部分更新外部金鑰設定。省略的欄位將保持不變。
刪除外部金鑰
client.beta.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse刪除外部金鑰設定。
驗證外部金鑰
client.beta.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponse針對客戶的 KMS 驗證外部金鑰設定。
Beta組織聯合簽發者
建立聯合簽發者
client.beta.organization.federation.issuers.create(params, options?): BetaFederationIssuer需要具有 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>需要具有 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需要具有 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需要具有 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需要具有 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需要具有 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>需要具有 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需要具有 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需要具有 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需要具有 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需要具有 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>需要具有 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需要具有 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透過電子郵件邀請使用者加入組織。
列出邀請
client.beta.organization.invites.list(query?, options?): Page<BetaOrganizationInvite>列出組織的邀請。
取得邀請
client.beta.organization.invites.retrieve(inviteID, options?): BetaOrganizationInvite依 ID 擷取邀請。
刪除邀請
client.beta.organization.invites.delete(inviteID, options?): InviteDeleteResponse刪除待處理的邀請。
Beta組織服務帳戶
建立服務帳戶
client.beta.organization.serviceAccounts.create(params, options?): BetaServiceAccount需要具有 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>需要具有 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需要具有 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需要具有 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需要具有 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需要具有 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>需要具有 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需要具有 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>列出組織的成員。
取得使用者
client.beta.organization.users.retrieve(userID, options?): BetaOrganizationUser依使用者 ID 擷取組織成員。
更新使用者
client.beta.organization.users.update(userID, body, options?): BetaOrganizationUser更新成員的組織角色。
移除使用者
client.beta.organization.users.remove(userID, options?): UserRemoveResponse從組織中移除成員。
Beta組織工作區
列出工作區
client.beta.organization.workspaces.list(query?, options?): Page<BetaWorkspace>建立工作區
client.beta.organization.workspaces.create(params, options?): BetaWorkspace取得工作區
client.beta.organization.workspaces.retrieve(workspaceID, options?): BetaWorkspace更新工作區
client.beta.organization.workspaces.update(workspaceID, body, options?): BetaWorkspace封存工作區
client.beta.organization.workspaces.archive(workspaceID, options?): BetaWorkspaceBeta組織工作區速率限制
列出工作區速率限制
client.beta.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<BetaWorkspaceRateLimit>列出工作區的速率限制。
Beta組織工作區成員
列出工作區成員
client.beta.organization.workspaces.members.list(workspaceID, query?, options?): Page<BetaWorkspaceMember>建立工作區成員
client.beta.organization.workspaces.members.add(workspaceID, body, options?): BetaWorkspaceMember取得工作區成員
client.beta.organization.workspaces.members.retrieve(userID, params, options?): BetaWorkspaceMember更新工作區成員
client.beta.organization.workspaces.members.update(userID, params, options?): BetaWorkspaceMember刪除工作區成員
client.beta.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponseBeta組織工作區服務帳戶
列出服務帳戶工作區成員
client.beta.organization.workspaces.serviceAccounts.list(workspaceID, params?, options?): PageCursor<BetaServiceAccountWorkspaceMember>需要具有 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需要具有 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需要具有 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需要具有 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需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
Beta組織速率限制
列出組織速率限制
client.beta.organization.rateLimits.list(query?, options?): PageCursor<BetaOrganizationRateLimit>列出您組織的 Messages API 速率限制。
Beta組織合規設定
取得合規設定
client.beta.organization.complianceSettings.retrieve(options?): BetaComplianceSettings擷取您組織的合規設定。
更新合規設定
client.beta.organization.complianceSettings.update(body, options?): BetaComplianceSettings更新您組織的合規設定。
Beta組織分析摘要
取得活動摘要
client.beta.organization.analytics.summaries.list(query, options?): PageCursor<BetaAnalyticsSingleDayActivitySummary>取得指定日期範圍內的全組織活動摘要。
Beta組織分析使用者
列出使用者活動
client.beta.organization.analytics.users.list(query?, options?): PageCursor<BetaAnalyticsUserActivity>取得指定日期的每位使用者活動,採用游標式分頁。
Beta組織分析應用程式聊天專案
取得聊天專案用量
client.beta.organization.analytics.apps.chat.projects.list(query?, options?): PageCursor<BetaAnalyticsProjectActivity>取得指定日期的每個專案活動,並支援以游標為基礎的分頁。
Beta組織分析連接器
取得連接器使用量
client.beta.organization.analytics.connectors.list(query?, options?): PageCursor<BetaAnalyticsConnectorActivity>取得指定日期的每個連接器用量,採用游標式分頁。
Beta組織分析外掛程式
取得外掛程式使用量
client.beta.organization.analytics.plugins.list(query?, options?): PageCursor<BetaAnalyticsPluginActivity>取得指定日期的每個外掛程式安裝與呼叫用量,採用分頁。
Beta組織分析技能
取得技能使用量
client.beta.organization.analytics.skills.list(query?, options?): PageCursor<BetaAnalyticsSkillActivity>取得指定日期的每項技能用量,採用游標式分頁。
Beta組織分析Artifacts
取得 Artifact 活動
client.beta.organization.analytics.artifacts.list(query, options?): PageCursor<BetaAnalyticsArtifactActivity>取得指定日期的 artifact 建立活動,依 MIME 類型細分。
Beta組織分析使用量報告
取得隨時間變化的 Token 用量
client.beta.organization.analytics.usageReport.list(query, options?): PageCursor<BetaAnalyticsUsageReportTimeBucket>取得某個日期範圍內隨時間變化的 token 用量。
Beta組織分析使用者用量報告
取得每位使用者的 Token 用量
client.beta.organization.analytics.userUsageReport.list(query, options?): PageCursor<BetaAnalyticsUsageUsersItem>取得某個日期範圍內每位使用者的 token 用量。
Beta組織分析成本報告
取得隨時間變化的成本
client.beta.organization.analytics.costReport.list(query, options?): PageCursor<BetaAnalyticsCostReportTimeBucket>取得某個日期範圍內隨時間變化的成本(以美元計)。
Beta組織分析使用者成本報告
取得每位使用者的成本
client.beta.organization.analytics.userCostReport.list(query, options?): PageCursor<BetaAnalyticsCostUsersItem>取得某個日期範圍內每位使用者的成本(以美元計)。
Beta組織支出限制
設定支出限制
client.beta.organization.spendLimits.set(params, options?): BetaSpendLimit設定支出限制。
取得支出限制
client.beta.organization.spendLimits.retrieve(spendLimitID, options?): BetaSpendLimit依 ID 擷取支出限制。
刪除支出限制
client.beta.organization.spendLimits.delete(spendLimitID, options?): SpendLimitDeleteResponse刪除支出限制。
列出支出限制
client.beta.organization.spendLimits.list(params?, options?): PageCursor<BetaSpendLimit>列出組織的支出限制。
Beta組織支出限制有效
列出有效支出限制
client.beta.organization.spendLimits.effective.list(query?, options?): PageCursor<BetaSpendSummary>列出每位成員的有效支出限制及本期至今的支出。
Beta組織支出限制提高請求
列出支出限制提高請求
client.beta.organization.spendLimits.increaseRequests.list(query?, options?): PageCursor<BetaSpendLimitIncreaseRequest>列出支出限制提高請求,最新的在前。
取得支出限制提高請求
client.beta.organization.spendLimits.increaseRequests.retrieve(spendLimitIncreaseRequestID, options?): BetaSpendLimitIncreaseRequest擷取支出限制提高請求。
核准支出限制提高請求
client.beta.organization.spendLimits.increaseRequests.approve(spendLimitIncreaseRequestID, body, options?): IncreaseRequestApproveResponse核准待處理的支出限制提高請求。
拒絕支出限制提高請求
client.beta.organization.spendLimits.increaseRequests.deny(spendLimitIncreaseRequestID, body, options?): BetaSpendLimitIncreaseRequest拒絕待處理的支出限制提高請求。
Beta組織RBAC 群組
建立 RBAC 群組
client.beta.organization.rbacGroups.create(body, options?): BetaRBACGroup在 Claude Enterprise 租戶中建立 RBAC 群組。透過 API 建立的群組其來源類型為 "direct"。
列出 RBAC 群組
client.beta.organization.rbacGroups.list(query?, options?): PageCursor<BetaRBACGroup>列出 Claude Enterprise 租戶中的 RBAC 群組。
取得 RBAC 群組
client.beta.organization.rbacGroups.retrieve(rbacGroupID, options?): BetaRBACGroup依 ID 擷取 RBAC 群組。
更新 RBAC 群組
client.beta.organization.rbacGroups.update(rbacGroupID, body, options?): BetaRBACGroup更新 RBAC 群組的名稱。當租用戶中的組織使用 SCIM 佈建時,由身分識別提供者佈建的群組(來源類型為 "scim")無法透過 API 修改。
刪除 RBAC 群組
client.beta.organization.rbacGroups.delete(rbacGroupID, options?): RBACGroupDeleteResponse刪除 RBAC 群組。當租用戶中的組織使用 SCIM 佈建時,由身分識別提供者佈建的群組(來源類型為 "scim")無法透過 API 刪除。
Beta組織RBAC 群組成員
列出 RBAC 群組成員
client.beta.organization.rbacGroups.members.list(rbacGroupID, query?, options?): PageCursor<BetaRBACGroupMember>列出 RBAC 群組的成員。
新增 RBAC 群組成員
client.beta.organization.rbacGroups.members.add(rbacGroupID, body, options?): BetaRBACGroupMember將使用者新增至 RBAC 群組。當租用戶中的組織使用 SCIM 佈建時,由身分識別提供者佈建的群組(來源類型為 "scim")其成員資格無法透過 API 修改。
移除 RBAC 群組成員
client.beta.organization.rbacGroups.members.remove(userID, params, options?): MemberRemoveResponse從 RBAC 群組中移除使用者。當租用戶中的組織使用 SCIM 佈建時,由身分識別提供者佈建的群組(來源類型為 "scim")其成員資格無法透過 API 修改。
Beta組織RBAC 角色
列出 RBAC 角色
client.beta.organization.rbacRoles.list(query?, options?): PageCursor<BetaRBACRole>列出組織中的 RBAC 角色。
取得 RBAC 角色
client.beta.organization.rbacRoles.retrieve(rbacRoleID, options?): BetaRBACRole依 ID 擷取 RBAC 角色。
Beta組織RBAC 角色權限
列出 RBAC 角色權限
client.beta.organization.rbacRoles.permissions.list(rbacRoleID, query?, options?): PageCursor<BetaRBACRolePermission>列出 RBAC 角色所授予的權限。
Beta組織外掛程式
建立外掛程式
client.beta.organization.plugins.create(params, options?): BetaPlugin上傳版本的檔案,以建立組織擁有的外掛程式(Plugin)及其 第一個版本。
取得外掛程式
client.beta.organization.plugins.retrieve(pluginID, params?, options?): BetaPlugin依 ID 擷取外掛程式。
更新外掛程式
client.beta.organization.plugins.update(pluginID, params, options?): BetaPlugin變更向成員提供的組織擁有 Plugin 的已儲存版本,例如回復到較早的版本。這會釘選所提供的版本:之後上傳的版本仍會儲存,但不再改變所提供的內容,且目前無法取消釘選,無論在此處或在 claude.ai 中皆然。
列出 Plugin
client.beta.organization.plugins.list(params?, options?): PageCursor<BetaPlugin>列出在組織下建立的 Plugin,依最新優先排序:包括組織自有外掛程式市集中的 Plugin,以及成員個人外掛程式市集中的 Plugin。
刪除 Plugin
client.beta.organization.plugins.delete(pluginID, params?, options?): BetaDeletedPlugin永久刪除 Plugin 及其所有版本,效果與管理員在 claude.ai 中刪除時完全相同。該 Plugin 可以屬於組織或成員,包括已離開組織的成員。
Beta組織外掛程式版本
建立 Plugin 版本
client.beta.organization.plugins.versions.create(pluginID, params, options?): BetaPluginVersion透過上傳新版本的檔案,為組織擁有的 Plugin 新增版本;除非該 Plugin 所提供的版本已被釘選,否則新版本會成為向成員提供的版本。
列出 Plugin 版本
client.beta.organization.plugins.versions.list(pluginID, params?, options?): PageCursor<BetaPluginVersion>列出 Plugin 的版本,依最新優先排序。
取得 Plugin 版本
client.beta.organization.plugins.versions.retrieve(version, params, options?): BetaPluginVersion依 ID 擷取 Plugin 的某個版本,或擷取 Plugin 的最新版本。
下載 Plugin 版本封存檔
client.beta.organization.plugins.versions.download(version, params, options?): Response下載某個版本的 .zip 封存檔,內容與儲存時完全相同。每次從成員個人外掛程式市集下載 Plugin,都會記錄在 Compliance API 活動摘要中。
Beta組織外掛程式安裝設定
列出 Plugin 安裝設定
client.beta.organization.plugins.installationSettings.list(pluginID, params?, options?): PageCursor<BetaPluginInstallationSetting>列出組織擁有的 Plugin 的安裝設定(用於指定該 Plugin 適用於哪些成員),依建立時間由新到舊排序。
設定 Plugin 安裝設定
client.beta.organization.plugins.installationSettings.set(target, params, options?): BetaPluginInstallationSetting為整個組織或單一 RBAC 群組設定或變更組織擁有的 Plugin 的安裝設定。
移除 Plugin 安裝設定
client.beta.organization.plugins.installationSettings.remove(target, params, options?): BetaDeletedPluginInstallationSetting移除組織擁有的 Plugin 針對整個組織或單一 RBAC 群組本身的安裝設定。
Beta組織外掛程式市集
列出外掛程式市集
client.beta.organization.pluginMarketplaces.list(params?, options?): PageCursor<BetaPluginMarketplace>列出 Plugin 所在的外掛程式市集,依最新優先排序:包括組織自有的市集及其成員的個人市集。
取得外掛程式市集
client.beta.organization.pluginMarketplaces.retrieve(marketplaceID, params?, options?): BetaPluginMarketplace依 ID 擷取外掛程式市集。
更新外掛程式市集
client.beta.organization.pluginMarketplaces.update(marketplaceID, params, options?): BetaPluginMarketplace設定組織自有外掛程式市集之一的預設安裝設定。該市集中每個沒有自身設定的 Plugin(包括之後新增的 Plugin)都會以此預設值作為其全組織設定。
驗證外掛程式市集儲存庫
client.beta.organization.pluginMarketplaces.validateRepository(params, options?): BetaPluginMarketplaceValidationReport檢查存放於公開 GitHub 儲存庫中的外掛程式市集是否能同步至 claude.ai,而不會連接或儲存該市集。
驗證外掛程式市集封存檔
client.beta.organization.pluginMarketplaces.validateArchive(params, options?): BetaPluginMarketplaceValidationReport檢查以市集目錄 .zip 形式上傳的外掛程式市集是否能同步至 claude.ai,而不會連接或儲存該市集。