Beta
Models
Beta模型
获取模型
client.beta.models.retrieve(modelID, params?, options?): BetaModelInfo获取特定模型。
Beta消息
创建消息
client.beta.messages.create(params, options?): BetaMessage | Stream<BetaRawMessageStreamEvent>发送包含文本和/或图像内容的结构化输入消息列表,模型将生成对话中的下一条消息。
计算消息中的令牌数
client.beta.messages.countTokens(params, options?): BetaMessageTokensCount计算消息中的令牌数量。
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 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
列出联合颁发者
client.beta.organization.federation.issuers.list(params?, options?): PageCursor<BetaFederationIssuer>需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
获取联合颁发者
client.beta.organization.federation.issuers.retrieve(federationIssuerID, params?, options?): BetaFederationIssuer需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
更新联合颁发者
client.beta.organization.federation.issuers.update(federationIssuerID, params, options?): BetaFederationIssuer需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
归档联合颁发者
client.beta.organization.federation.issuers.archive(federationIssuerID, params?, options?): BetaFederationIssuer需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
Beta组织联合规则
创建联合规则
client.beta.organization.federation.rules.create(params, options?): BetaFederationRule需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
列出联合规则
client.beta.organization.federation.rules.list(params?, options?): PageCursor<BetaFederationRule>需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
获取联合规则
client.beta.organization.federation.rules.retrieve(federationRuleID, params?, options?): BetaFederationRule需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
更新联合规则
client.beta.organization.federation.rules.update(federationRuleID, params, options?): BetaFederationRule需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
归档联合规则
client.beta.organization.federation.rules.archive(federationRuleID, params?, options?): BetaFederationRule需要具有 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需要具有 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>需要具有 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需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 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 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
列出服务账号
client.beta.organization.serviceAccounts.list(params?, options?): PageCursor<BetaServiceAccount>需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
获取服务账号
client.beta.organization.serviceAccounts.retrieve(serviceAccountID, params?, options?): BetaServiceAccount需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
更新服务账号
client.beta.organization.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccount需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
归档服务账号
client.beta.organization.serviceAccounts.archive(serviceAccountID, params?, options?): BetaServiceAccount需要具有 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需要具有 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>需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
从服务账号中移除工作区
client.beta.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 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>列出工作区的速率限制(rate limit)。
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 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
创建服务账号工作区成员
client.beta.organization.workspaces.serviceAccounts.add(workspaceID, params, options?): BetaServiceAccountWorkspaceMember需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
获取服务账号工作区成员
client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
更新服务账号工作区成员
client.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。
删除服务账号工作区成员
client.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): ServiceAccountRemoveResponse需要具有 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>列出您组织的 Messages API "rate limit"(速率限制)。
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组织分析使用情况报告
获取随时间变化的令牌用量
client.beta.organization.analytics.usageReport.list(query, options?): PageCursor<BetaAnalyticsUsageReportTimeBucket>获取某个日期范围内随时间变化的令牌用量。
Beta组织分析用户用量报告
获取每用户令牌用量
client.beta.organization.analytics.userUsageReport.list(query, options?): PageCursor<BetaAnalyticsUsageUsersItem>获取某个日期范围内的每用户令牌用量。
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通过上传版本文件,创建组织拥有的插件及其第一个版本。
获取插件
client.beta.organization.plugins.retrieve(pluginID, params?, options?): BetaPlugin按 ID 检索插件。
更新插件
client.beta.organization.plugins.update(pluginID, params, options?): BetaPlugin更改向成员提供的组织所有插件的已存储版本,例如回滚到较早的版本。此操作会固定所提供的版本:之后上传的版本仍会被存储,但不再改变所提供的内容,并且固定目前无法撤销,无论是在此处还是在 claude.ai 中。
列出插件
client.beta.organization.plugins.list(params?, options?): PageCursor<BetaPlugin>列出在组织下创建的插件,按从新到旧排序:包括组织自有插件市场中的插件以及成员个人插件市场中的插件。
删除插件
client.beta.organization.plugins.delete(pluginID, params?, options?): BetaDeletedPlugin永久删除一个插件及其包含的所有版本,效果与管理员在 claude.ai 中删除它完全相同。该插件可以属于组织,也可以属于某个成员,包括此后已离开组织的成员。
Beta组织插件版本
创建插件版本
client.beta.organization.plugins.versions.create(pluginID, params, options?): BetaPluginVersion通过上传新版本的文件为组织所有的插件添加一个版本;除非该插件的提供版本已被固定,否则新版本将成为向成员提供的版本。
列出插件版本
client.beta.organization.plugins.versions.list(pluginID, params?, options?): PageCursor<BetaPluginVersion>列出插件的版本,按从新到旧排序。
获取插件版本
client.beta.organization.plugins.versions.retrieve(version, params, options?): BetaPluginVersion按 ID 检索插件的某个版本,或检索插件的最新版本。
下载插件版本归档
client.beta.organization.plugins.versions.download(version, params, options?): Response按原样下载某个版本的 .zip 归档文件。每次从成员个人插件市场下载插件都会记录在 Compliance API 活动源中。
Beta组织插件安装设置
列出插件安装设置
client.beta.organization.plugins.installationSettings.list(pluginID, params?, options?): PageCursor<BetaPluginInstallationSetting>列出组织所有插件的安装设置(这些设置说明插件面向哪些成员),按创建时间从新到旧排序。
设置插件安装设置
client.beta.organization.plugins.installationSettings.set(target, params, options?): BetaPluginInstallationSetting为整个组织或某个 RBAC 组设置或更改组织所有插件的安装设置。
移除插件安装设置
client.beta.organization.plugins.installationSettings.remove(target, params, options?): BetaDeletedPluginInstallationSetting移除组织所有插件针对整个组织或某个 RBAC 组的自身安装设置。
Beta组织插件市场
列出插件市场
client.beta.organization.pluginMarketplaces.list(params?, options?): PageCursor<BetaPluginMarketplace>列出插件所在的插件市场,按从新到旧排序:包括组织自有的市场及其成员的个人市场。
获取插件市场
client.beta.organization.pluginMarketplaces.retrieve(marketplaceID, params?, options?): BetaPluginMarketplace按 ID 检索插件市场。
更新插件市场
client.beta.organization.pluginMarketplaces.update(marketplaceID, params, options?): BetaPluginMarketplace设置组织自有插件市场之一的默认安装设置。该市场中所有没有自身设置的插件(包括之后添加的插件)都会将此默认值作为其组织范围设置。
验证插件市场代码仓库
client.beta.organization.pluginMarketplaces.validateRepository(params, options?): BetaPluginMarketplaceValidationReport检查存放在公共 GitHub 代码仓库中的插件市场能否同步到 claude.ai,而不会连接或存储该市场。
验证插件市场归档
client.beta.organization.pluginMarketplaces.validateArchive(params, options?): BetaPluginMarketplaceValidationReport检查以市场目录 .zip 文件形式上传的插件市场能否同步到 claude.ai,而不会连接或存储该市场。