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

发送包含文本和/或图像内容的结构化输入消息列表,模型将生成对话中的下一条消息。

计算消息中的令牌数
client.beta.messages.countTokens(params, options?): BetaMessageTokensCount
POST/v1/messages/count_tokens

计算消息中的令牌数量。

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 文件的形式流式传输消息批次的结果。

Beta代理

创建代理
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

获取某个环境的工作队列统计信息。

Beta会话

创建会话
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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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

列出工作区的速率限制(rate limit)。

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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 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 或 "workload identity federation"(工作负载身份联合)规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

Beta组织速率限制

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

列出您组织的 Messages API "rate limit"(速率限制)。

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组织分析使用情况报告

获取随时间变化的令牌用量
client.beta.organization.analytics.usageReport.list(query, options?): PageCursor<BetaAnalyticsUsageReportTimeBucket>
GET/v1/organizations/analytics/usage_report

获取某个日期范围内随时间变化的令牌用量。

Beta组织分析用户用量报告

获取每用户令牌用量
client.beta.organization.analytics.userUsageReport.list(query, options?): PageCursor<BetaAnalyticsUsageUsersItem>
GET/v1/organizations/analytics/user_usage_report

获取某个日期范围内的每用户令牌用量。

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

通过上传版本文件,创建组织拥有的插件及其第一个版本。

获取插件
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}

更改向成员提供的组织所有插件的已存储版本,例如回滚到较早的版本。此操作会固定所提供的版本:之后上传的版本仍会被存储,但不再改变所提供的内容,并且固定目前无法撤销,无论是在此处还是在 claude.ai 中。

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

列出在组织下创建的插件,按从新到旧排序:包括组织自有插件市场中的插件以及成员个人插件市场中的插件。

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

永久删除一个插件及其包含的所有版本,效果与管理员在 claude.ai 中删除它完全相同。该插件可以属于组织,也可以属于某个成员,包括此后已离开组织的成员。

Beta组织插件版本

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

通过上传新版本的文件为组织所有的插件添加一个版本;除非该插件的提供版本已被固定,否则新版本将成为向成员提供的版本。

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

列出插件的版本,按从新到旧排序。

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

按 ID 检索插件的某个版本,或检索插件的最新版本。

下载插件版本归档
client.beta.organization.plugins.versions.download(version, params, options?): Response
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

按原样下载某个版本的 .zip 归档文件。每次从成员个人插件市场下载插件都会记录在 Compliance API 活动源中。

Beta组织插件安装设置

列出插件安装设置
client.beta.organization.plugins.installationSettings.list(pluginID, params?, options?): PageCursor<BetaPluginInstallationSetting>
GET/v1/organizations/plugins/{plugin_id}/installation_settings

列出组织所有插件的安装设置(这些设置说明插件面向哪些成员),按创建时间从新到旧排序。

设置插件安装设置
client.beta.organization.plugins.installationSettings.set(target, params, options?): BetaPluginInstallationSetting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

为整个组织或某个 RBAC 组设置或更改组织所有插件的安装设置。

移除插件安装设置
client.beta.organization.plugins.installationSettings.remove(target, params, options?): BetaDeletedPluginInstallationSetting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

移除组织所有插件针对整个组织或某个 RBAC 组的自身安装设置。

Beta组织插件共享

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

列出成员所有插件的所有者所授予的共享(共享给组织的所有成员、某个 RBAC 组或某个成员),按授予时间从新到旧排序。

Beta组织插件市场

列出插件市场
client.beta.organization.pluginMarketplaces.list(params?, options?): PageCursor<BetaPluginMarketplace>
GET/v1/organizations/plugin_marketplaces

列出插件所在的插件市场,按从新到旧排序:包括组织自有的市场及其成员的个人市场。

获取插件市场
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}

设置组织自有插件市场之一的默认安装设置。该市场中所有没有自身设置的插件(包括之后添加的插件)都会将此默认值作为其组织范围设置。

验证插件市场代码仓库
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,而不会连接或存储该市场。