Claude Platform Docs

Beta

Models
class BetaApiError { Type = "api_error"; Message; }
JsonElement Type = "api_error"
required string Message
class BetaAuthenticationError { Type = "authentication_error"; Message; }
JsonElement Type = "authentication_error"
required string Message
class BetaBillingError { Type = "billing_error"; Message; }
JsonElement Type = "billing_error"
required string Message
enum BetaCurrency
Usd("USD")
class BetaError: union
class BetaErrorResponse { Type = "error"; Error; RequestID; }
JsonElement Type = "error"
required BetaError Error
One of the following:
required string? RequestID
class BetaGatewayTimeoutError { Type = "timeout_error"; Message; }
JsonElement Type = "timeout_error"
required string Message
class BetaInvalidRequestError { Type = "invalid_request_error"; Message; }
JsonElement Type = "invalid_request_error"
required string Message
class BetaMonetaryAmount { Amount; Currency; }

A monetary amount in a specific currency.

required string Amount

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.

required BetaCurrency Currency

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.

class BetaNotFoundError { Type = "not_found_error"; Message; }
JsonElement Type = "not_found_error"
required string Message
class BetaOverloadedError { Type = "overloaded_error"; Message; }
JsonElement Type = "overloaded_error"
required string Message
class BetaPermissionError { Type = "permission_error"; Message; }
JsonElement Type = "permission_error"
required string Message
class BetaRateLimitError { Type = "rate_limit_error"; Message; }
JsonElement Type = "rate_limit_error"
required string Message

Beta模型

列出模型
ModelListPage Beta.Models.List(parameters, cancellationToken = default)
GET/v1/models

列出可用模型。

获取模型
BetaModelInfo Beta.Models.Retrieve(parameters, cancellationToken = default)
GET/v1/models/{model_id}

获取特定模型。

Beta消息

创建消息
BetaMessage Beta.Messages.Create(parameters, cancellationToken = default)
POST/v1/messages

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

计算消息中的令牌数
BetaMessageTokensCount Beta.Messages.CountTokens(parameters, cancellationToken = default)
POST/v1/messages/count_tokens

计算消息中的令牌数量。

Beta消息批处理

创建消息批次
BetaMessageBatch Beta.Messages.Batches.Create(parameters, cancellationToken = default)
POST/v1/messages/batches

发送一批消息创建请求。

检索消息批次
BetaMessageBatch Beta.Messages.Batches.Retrieve(parameters, cancellationToken = default)
GET/v1/messages/batches/{message_batch_id}

此端点是幂等的,可用于轮询消息批次是否完成。要访问消息批次的结果,请向响应中的 results_url 字段发起请求。

列出消息批次
BatchListPage Beta.Messages.Batches.List(parameters, cancellationToken = default)
GET/v1/messages/batches

列出工作区内的所有消息批次。最近创建的批次最先返回。

取消消息批次
BetaMessageBatch Beta.Messages.Batches.Cancel(parameters, cancellationToken = default)
POST/v1/messages/batches/{message_batch_id}/cancel

批次可在处理结束前的任何时间取消。一旦发起取消,批次将进入 canceling 状态,此时系统可能会先完成任何正在进行的、不可中断的请求,然后再最终完成取消。

删除消息批次
BetaDeletedMessageBatch Beta.Messages.Batches.Delete(parameters, cancellationToken = default)
DELETE/v1/messages/batches/{message_batch_id}

删除消息批次。

检索消息批次结果
BetaMessageBatchIndividualResponse Beta.Messages.Batches.ResultsStreaming(parameters, cancellationToken = default)
GET/v1/messages/batches/{message_batch_id}/results

.jsonl 文件的形式流式传输消息批次的结果。

Beta代理

创建代理
BetaManagedAgentsAgent Beta.Agents.Create(parameters, cancellationToken = default)
POST/v1/agents
列出代理
AgentListPage Beta.Agents.List(parameters, cancellationToken = default)
GET/v1/agents
获取代理
BetaManagedAgentsAgent Beta.Agents.Retrieve(parameters, cancellationToken = default)
GET/v1/agents/{agent_id}
更新代理
BetaManagedAgentsAgent Beta.Agents.Update(parameters, cancellationToken = default)
POST/v1/agents/{agent_id}
归档代理
BetaManagedAgentsAgent Beta.Agents.Archive(parameters, cancellationToken = default)
POST/v1/agents/{agent_id}/archive

Beta代理版本

列出代理版本
VersionListPage Beta.Agents.Versions.List(parameters, cancellationToken = default)
GET/v1/agents/{agent_id}/versions

Beta环境

创建环境
BetaEnvironment Beta.Environments.Create(parameters, cancellationToken = default)
POST/v1/environments

使用指定配置创建新环境。

列出环境
EnvironmentListPage Beta.Environments.List(parameters, cancellationToken = default)
GET/v1/environments

列出环境,支持分页。

获取环境
BetaEnvironment Beta.Environments.Retrieve(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}

按 ID 检索特定环境。

更新环境
BetaEnvironment Beta.Environments.Update(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}

更新现有环境的配置。

删除环境
BetaEnvironmentDeleteResponse Beta.Environments.Delete(parameters, cancellationToken = default)
DELETE/v1/environments/{environment_id}

按 ID 删除环境。返回删除确认。

归档环境
BetaEnvironment Beta.Environments.Archive(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}/archive

按 ID 归档环境。已归档的环境不能用于创建新会话。

Beta环境工作

获取工作项
BetaSelfHostedWork Beta.Environments.Work.Retrieve(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}/work/{work_id}

注意:这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用,用于编排使用自托管沙箱环境的会话。此处列出仅供参考;您无需直接调用它们。

轮询工作
BetaSelfHostedWork? Beta.Environments.Work.Poll(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}/work/poll

注意:这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用,用于编排使用自托管沙箱环境的会话。此处列出仅供参考;您无需直接调用它们。

确认工作
BetaSelfHostedWork Beta.Environments.Work.Ack(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}/work/{work_id}/ack

注意:这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用,用于编排使用自托管沙箱环境的会话。此处列出仅供参考;您无需直接调用它们。

记录心跳
BetaSelfHostedWorkHeartbeatResponse Beta.Environments.Work.Heartbeat(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

注意:这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用,用于编排使用自托管沙箱环境的会话。此处列出仅供参考;您无需直接调用它们。

停止工作
BetaSelfHostedWork Beta.Environments.Work.Stop(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}/work/{work_id}/stop

注意:这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用,用于编排使用自托管沙箱环境的会话。此处列出仅供参考;您无需直接调用它们。

列出工作项
WorkListPage Beta.Environments.Work.List(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}/work

注意:这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用,用于编排使用自托管沙箱环境的会话。此处列出仅供参考;您无需直接调用它们。

更新工作项
BetaSelfHostedWork Beta.Environments.Work.Update(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}/work/{work_id}

注意:这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用,用于编排使用自托管沙箱环境的会话。此处列出仅供参考;您无需直接调用它们。

获取队列统计信息
BetaSelfHostedWorkQueueStats Beta.Environments.Work.Stats(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}/work/stats

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

Beta会话

创建会话
BetaManagedAgentsSession Beta.Sessions.Create(parameters, cancellationToken = default)
POST/v1/sessions
列出会话
SessionListPage Beta.Sessions.List(parameters, cancellationToken = default)
GET/v1/sessions
获取会话
BetaManagedAgentsSession Beta.Sessions.Retrieve(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}
更新会话
BetaManagedAgentsSession Beta.Sessions.Update(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}
删除会话
BetaManagedAgentsDeletedSession Beta.Sessions.Delete(parameters, cancellationToken = default)
DELETE/v1/sessions/{session_id}
归档会话
BetaManagedAgentsSession Beta.Sessions.Archive(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/archive

Beta会话事件

列出事件
EventListPage Beta.Sessions.Events.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/events
发送事件
BetaManagedAgentsSendSessionEvents Beta.Sessions.Events.Send(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/events
流式传输事件
BetaManagedAgentsStreamSessionEvents Beta.Sessions.Events.StreamStreaming(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/events/stream

Beta会话资源

添加会话资源
BetaManagedAgentsFileResource Beta.Sessions.Resources.Add(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/resources
列出会话资源
ResourceListPage Beta.Sessions.Resources.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/resources
获取会话资源
ResourceRetrieveResponse Beta.Sessions.Resources.Retrieve(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/resources/{resource_id}
更新会话资源
ResourceUpdateResponse Beta.Sessions.Resources.Update(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/resources/{resource_id}
删除会话资源
BetaManagedAgentsDeleteSessionResource Beta.Sessions.Resources.Delete(parameters, cancellationToken = default)
DELETE/v1/sessions/{session_id}/resources/{resource_id}

Beta会话线程

列出会话线程
ThreadListPage Beta.Sessions.Threads.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads
获取会话线程
BetaManagedAgentsSessionThread Beta.Sessions.Threads.Retrieve(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads/{thread_id}
归档会话线程
BetaManagedAgentsSessionThread Beta.Sessions.Threads.Archive(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

Beta会话线程事件

列出会话线程事件
EventListPage Beta.Sessions.Threads.Events.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads/{thread_id}/events
流式传输会话线程事件
BetaManagedAgentsStreamSessionThreadEvents Beta.Sessions.Threads.Events.StreamStreaming(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

Beta部署

创建部署
BetaManagedAgentsDeployment Beta.Deployments.Create(parameters, cancellationToken = default)
POST/v1/deployments
列出部署
DeploymentListPage Beta.Deployments.List(parameters, cancellationToken = default)
GET/v1/deployments
获取部署
BetaManagedAgentsDeployment Beta.Deployments.Retrieve(parameters, cancellationToken = default)
GET/v1/deployments/{deployment_id}
更新部署
BetaManagedAgentsDeployment Beta.Deployments.Update(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}
归档部署
BetaManagedAgentsDeployment Beta.Deployments.Archive(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/archive
立即运行部署
BetaManagedAgentsDeploymentRun Beta.Deployments.Run(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/run
暂停部署
BetaManagedAgentsDeployment Beta.Deployments.Pause(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/pause
取消暂停部署
BetaManagedAgentsDeployment Beta.Deployments.Unpause(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/unpause
列出部署运行
DeploymentRunListPage Beta.DeploymentRuns.List(parameters, cancellationToken = default)
GET/v1/deployment_runs
获取部署运行
BetaManagedAgentsDeploymentRun Beta.DeploymentRuns.Retrieve(parameters, cancellationToken = default)
GET/v1/deployment_runs/{deployment_run_id}

Beta保管库

创建保管库
BetaManagedAgentsVault Beta.Vaults.Create(parameters, cancellationToken = default)
POST/v1/vaults
列出保管库
VaultListPage Beta.Vaults.List(parameters, cancellationToken = default)
GET/v1/vaults
获取保管库
BetaManagedAgentsVault Beta.Vaults.Retrieve(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}
更新保管库
BetaManagedAgentsVault Beta.Vaults.Update(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}
删除保管库
BetaManagedAgentsDeletedVault Beta.Vaults.Delete(parameters, cancellationToken = default)
DELETE/v1/vaults/{vault_id}
归档保管库
BetaManagedAgentsVault Beta.Vaults.Archive(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/archive

Beta保管库凭证

创建凭证
BetaManagedAgentsCredential Beta.Vaults.Credentials.Create(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials
列出凭证
CredentialListPage Beta.Vaults.Credentials.List(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}/credentials
获取凭证
BetaManagedAgentsCredential Beta.Vaults.Credentials.Retrieve(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}/credentials/{credential_id}
更新凭证
BetaManagedAgentsCredential Beta.Vaults.Credentials.Update(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}
删除凭证
BetaManagedAgentsDeletedCredential Beta.Vaults.Credentials.Delete(parameters, cancellationToken = default)
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
归档凭证
BetaManagedAgentsCredential Beta.Vaults.Credentials.Archive(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
验证凭证
BetaManagedAgentsCredentialValidation Beta.Vaults.Credentials.McpOAuthValidate(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate
创建记忆存储
BetaManagedAgentsMemoryStore Beta.MemoryStores.Create(parameters, cancellationToken = default)
POST/v1/memory_stores
列出记忆存储
MemoryStoreListPage Beta.MemoryStores.List(parameters, cancellationToken = default)
GET/v1/memory_stores
检索记忆存储
BetaManagedAgentsMemoryStore Beta.MemoryStores.Retrieve(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}
更新记忆存储
BetaManagedAgentsMemoryStore Beta.MemoryStores.Update(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}
删除记忆存储
BetaManagedAgentsDeletedMemoryStore Beta.MemoryStores.Delete(parameters, cancellationToken = default)
DELETE/v1/memory_stores/{memory_store_id}
归档记忆存储
BetaManagedAgentsMemoryStore Beta.MemoryStores.Archive(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/archive

Beta记忆存储记忆

创建记忆
BetaManagedAgentsMemory Beta.MemoryStores.Memories.Create(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/memories
列出记忆
MemoryListPage Beta.MemoryStores.Memories.List(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memories
检索记忆
BetaManagedAgentsMemory Beta.MemoryStores.Memories.Retrieve(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
更新记忆
BetaManagedAgentsMemory Beta.MemoryStores.Memories.Update(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
删除记忆
BetaManagedAgentsDeletedMemory Beta.MemoryStores.Memories.Delete(parameters, cancellationToken = default)
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

Beta记忆存储记忆版本

列出记忆版本
MemoryVersionListPage Beta.MemoryStores.MemoryVersions.List(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memory_versions
检索记忆版本
BetaManagedAgentsMemoryVersion Beta.MemoryStores.MemoryVersions.Retrieve(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
对记忆版本进行脱敏
BetaManagedAgentsMemoryVersion Beta.MemoryStores.MemoryVersions.Redact(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

Beta文件

上传文件
BetaFileMetadata Beta.Files.Upload(parameters, cancellationToken = default)
POST/v1/files
列出文件
FileListPage Beta.Files.List(parameters, cancellationToken = default)
GET/v1/files
下载文件
HttpResponse Beta.Files.Download(parameters, cancellationToken = default)
GET/v1/files/{file_id}/content
获取文件元数据
BetaFileMetadata Beta.Files.RetrieveMetadata(parameters, cancellationToken = default)
GET/v1/files/{file_id}
删除文件
BetaDeletedFile Beta.Files.Delete(parameters, cancellationToken = default)
DELETE/v1/files/{file_id}

Beta技能

创建技能
BetaSkill Beta.Skills.Create(parameters, cancellationToken = default)
POST/v1/skills
列出技能
SkillListPage Beta.Skills.List(parameters, cancellationToken = default)
GET/v1/skills
获取技能
BetaSkill Beta.Skills.Retrieve(parameters, cancellationToken = default)
GET/v1/skills/{skill_id}
删除技能
BetaDeletedSkill Beta.Skills.Delete(parameters, cancellationToken = default)
DELETE/v1/skills/{skill_id}

Beta技能版本

创建技能版本
BetaSkillVersion Beta.Skills.Versions.Create(parameters, cancellationToken = default)
POST/v1/skills/{skill_id}/versions
列出技能版本
VersionListPage Beta.Skills.Versions.List(parameters, cancellationToken = default)
GET/v1/skills/{skill_id}/versions
下载技能版本内容
HttpResponse Beta.Skills.Versions.Download(parameters, cancellationToken = default)
GET/v1/skills/{skill_id}/versions/{version}/content

以 zip 压缩包形式下载技能版本的内容。

获取技能版本
BetaSkillVersion Beta.Skills.Versions.Retrieve(parameters, cancellationToken = default)
GET/v1/skills/{skill_id}/versions/{version}
删除技能版本
BetaDeletedSkillVersion Beta.Skills.Versions.Delete(parameters, cancellationToken = default)
DELETE/v1/skills/{skill_id}/versions/{version}
创建用户配置文件
BetaUserProfile Beta.UserProfiles.Create(parameters, cancellationToken = default)
POST/v1/user_profiles
列出用户配置文件
UserProfileListPage Beta.UserProfiles.List(parameters, cancellationToken = default)
GET/v1/user_profiles
获取用户配置文件
BetaUserProfile Beta.UserProfiles.Retrieve(parameters, cancellationToken = default)
GET/v1/user_profiles/{user_profile_id}
更新用户配置文件
BetaUserProfile Beta.UserProfiles.Update(parameters, cancellationToken = default)
POST/v1/user_profiles/{user_profile_id}
创建注册 URL
BetaUserProfileEnrollmentUrl Beta.UserProfiles.CreateEnrollmentUrl(parameters, cancellationToken = default)
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDream

创建 Dream
BetaDream Beta.Dreams.Create(parameters, cancellationToken = default)
POST/v1/dreams
列出 Dream
DreamListPage Beta.Dreams.List(parameters, cancellationToken = default)
GET/v1/dreams
获取 Dream
BetaDream Beta.Dreams.Retrieve(parameters, cancellationToken = default)
GET/v1/dreams/{dream_id}
取消 Dream
BetaDream Beta.Dreams.Cancel(parameters, cancellationToken = default)
POST/v1/dreams/{dream_id}/cancel
归档 Dream
BetaDream Beta.Dreams.Archive(parameters, cancellationToken = default)
POST/v1/dreams/{dream_id}/archive

Beta隧道

创建隧道
BetaTunnel Beta.Tunnels.Create(parameters, cancellationToken = default)
POST/v1/tunnels

Tunnels API 目前处于研究预览阶段。它需要 anthropic-beta: mcp-tunnels-2026-06-22 请求头,并且可能在没有弃用期的情况下发生变更。它取代了位于 /v1/organizations/tunnels 的 Admin API 端点,这些端点在迁移窗口期内仍然可用。

获取隧道
BetaTunnel Beta.Tunnels.Retrieve(parameters, cancellationToken = default)
GET/v1/tunnels/{tunnel_id}

Tunnels API 目前处于研究预览阶段。它需要 anthropic-beta: mcp-tunnels-2026-06-22 请求头,并且可能在没有弃用期的情况下发生变更。它取代了位于 /v1/organizations/tunnels 的 Admin API 端点,这些端点在迁移窗口期内仍然可用。

列出隧道
TunnelListPage Beta.Tunnels.List(parameters, cancellationToken = default)
GET/v1/tunnels

Tunnels API 目前处于研究预览阶段。它需要 anthropic-beta: mcp-tunnels-2026-06-22 请求头,并且可能在没有弃用期的情况下发生变更。它取代了位于 /v1/organizations/tunnels 的 Admin API 端点,这些端点在迁移窗口期内仍然可用。

归档隧道
BetaTunnel Beta.Tunnels.Archive(parameters, cancellationToken = default)
POST/v1/tunnels/{tunnel_id}/archive

Tunnels API 目前处于研究预览阶段。它需要 anthropic-beta: mcp-tunnels-2026-06-22 请求头,并且可能在没有弃用期的情况下发生变更。它取代了位于 /v1/organizations/tunnels 的 Admin API 端点,这些端点在迁移窗口期内仍然可用。

显示隧道令牌
BetaTunnelToken Beta.Tunnels.RevealToken(parameters, cancellationToken = default)
POST/v1/tunnels/{tunnel_id}/reveal_token

Tunnels API 目前处于研究预览阶段。它需要 anthropic-beta: mcp-tunnels-2026-06-22 请求头,并且可能在没有弃用期的情况下发生变更。它取代了位于 /v1/organizations/tunnels 的 Admin API 端点,这些端点在迁移窗口期内仍然可用。

轮换隧道令牌
BetaTunnelToken Beta.Tunnels.RotateToken(parameters, cancellationToken = default)
POST/v1/tunnels/{tunnel_id}/rotate_token

Tunnels API 目前处于研究预览阶段。它需要 anthropic-beta: mcp-tunnels-2026-06-22 请求头,并且可能在没有弃用期的情况下发生变更。它取代了位于 /v1/organizations/tunnels 的 Admin API 端点,这些端点在迁移窗口期内仍然可用。

Beta隧道证书

创建隧道证书
BetaTunnelCertificate Beta.Tunnels.Certificates.Create(parameters, cancellationToken = default)
POST/v1/tunnels/{tunnel_id}/certificates

Tunnels API 目前处于研究预览阶段。它需要 anthropic-beta: mcp-tunnels-2026-06-22 请求头,并且可能在没有弃用期的情况下发生变更。它取代了位于 /v1/organizations/tunnels 的 Admin API 端点,这些端点在迁移窗口期内仍然可用。

获取隧道证书
BetaTunnelCertificate Beta.Tunnels.Certificates.Retrieve(parameters, cancellationToken = default)
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

Tunnels API 目前处于研究预览阶段。它需要 anthropic-beta: mcp-tunnels-2026-06-22 请求头,并且可能在没有弃用期的情况下发生变更。它取代了位于 /v1/organizations/tunnels 的 Admin API 端点,这些端点在迁移窗口期内仍然可用。

列出隧道证书
CertificateListPage Beta.Tunnels.Certificates.List(parameters, cancellationToken = default)
GET/v1/tunnels/{tunnel_id}/certificates

Tunnels API 目前处于研究预览阶段。它需要 anthropic-beta: mcp-tunnels-2026-06-22 请求头,并且可能在没有弃用期的情况下发生变更。它取代了位于 /v1/organizations/tunnels 的 Admin API 端点,这些端点在迁移窗口期内仍然可用。

归档隧道证书
BetaTunnelCertificate Beta.Tunnels.Certificates.Archive(parameters, cancellationToken = default)
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Tunnels API 目前处于研究预览阶段。它需要 anthropic-beta: mcp-tunnels-2026-06-22 请求头,并且可能在没有弃用期的情况下发生变更。它取代了位于 /v1/organizations/tunnels 的 Admin API 端点,这些端点在迁移窗口期内仍然可用。

Beta组织

获取当前组织
BetaOrganization Beta.Organization.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/me

检索与已认证 API 密钥关联的组织的信息。

Beta组织API 密钥

列出 API 密钥
ApiKeyListPage Beta.Organization.ApiKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
检索 API 密钥(Admin API)
BetaApiKey Beta.Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/api_keys/{api_key_id}

检索您组织中单个 API 密钥的信息,按其 ID 查找。此 Admin API 端点需要 Admin API 密钥,用于以编程方式管理密钥,并且永远不会返回密钥的机密值。要查看或创建您自己的 API 密钥,请前往 Claude Console 中的 API 密钥

更新 API 密钥
BetaApiKey Beta.Organization.ApiKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}

Beta组织外部密钥

创建外部密钥
BetaExternalKey Beta.Organization.ExternalKeys.Create(parameters, cancellationToken = default)
POST/v1/organizations/external_keys

创建由调用方组织拥有的外部密钥配置。

列出外部密钥
ExternalKeyListPage Beta.Organization.ExternalKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/external_keys

列出调用方组织中的外部密钥配置。

获取外部密钥
BetaExternalKey Beta.Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/external_keys/{external_key_id}

按 ID 检索调用方组织中的单个外部密钥配置。

更新外部密钥
BetaExternalKey Beta.Organization.ExternalKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}

部分更新外部密钥配置。省略的字段保持不变。

删除外部密钥
ExternalKeyDeleteResponse Beta.Organization.ExternalKeys.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/external_keys/{external_key_id}

删除外部密钥配置。

验证外部密钥
ExternalKeyValidateResponse Beta.Organization.ExternalKeys.Validate(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}/validate

针对客户的 KMS 验证外部密钥配置。

Beta组织联合颁发者

创建联合签发者
BetaFederationIssuer Beta.Organization.Federation.Issuers.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

列出联合签发者
IssuerListPage Beta.Organization.Federation.Issuers.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

获取联合签发者
BetaFederationIssuer Beta.Organization.Federation.Issuers.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers/{federation_issuer_id}

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

更新联合签发者
BetaFederationIssuer Beta.Organization.Federation.Issuers.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

归档联合签发者
BetaFederationIssuer Beta.Organization.Federation.Issuers.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

Beta组织联合规则

创建联合规则
BetaFederationRule Beta.Organization.Federation.Rules.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

列出联合规则
RuleListPage Beta.Organization.Federation.Rules.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

获取联合规则
BetaFederationRule Beta.Organization.Federation.Rules.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

更新联合规则
BetaFederationRule Beta.Organization.Federation.Rules.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

归档联合规则
BetaFederationRule Beta.Organization.Federation.Rules.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

Beta组织联合规则工作区

添加联合规则工作区
BetaFederationRuleWorkspace Beta.Organization.Federation.Rules.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

列出联合规则工作区
WorkspaceListPage Beta.Organization.Federation.Rules.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

移除联合规则工作区
WorkspaceRemoveResponse Beta.Organization.Federation.Rules.Workspaces.Remove(parameters, cancellationToken = default)
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组织邀请

创建邀请
BetaOrganizationInvite Beta.Organization.Invites.Create(parameters, cancellationToken = default)
POST/v1/organizations/invites

通过电子邮件邀请用户加入组织。

列出邀请
InviteListPage Beta.Organization.Invites.List(parameters, cancellationToken = default)
GET/v1/organizations/invites

列出组织的邀请。

获取邀请
BetaOrganizationInvite Beta.Organization.Invites.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/invites/{invite_id}

按 ID 检索邀请。

删除邀请
InviteDeleteResponse Beta.Organization.Invites.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/invites/{invite_id}

删除待处理的邀请。

Beta组织服务账户

创建服务账户
BetaServiceAccount Beta.Organization.ServiceAccounts.Create(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

列出服务账户
ServiceAccountListPage Beta.Organization.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

获取服务账户
BetaServiceAccount Beta.Organization.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

更新服务账户
BetaServiceAccount Beta.Organization.ServiceAccounts.Update(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

归档服务账户
BetaServiceAccount Beta.Organization.ServiceAccounts.Archive(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/archive

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

Beta组织服务账户工作区

将工作区添加到服务账户
BetaServiceAccountWorkspaceMember Beta.Organization.ServiceAccounts.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

列出服务账户的工作区
WorkspaceListPage Beta.Organization.ServiceAccounts.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

从服务账户移除工作区
WorkspaceRemoveResponse Beta.Organization.ServiceAccounts.Workspaces.Remove(parameters, cancellationToken = default)
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组织用户

列出用户
UserListPage Beta.Organization.Users.List(parameters, cancellationToken = default)
GET/v1/organizations/users

列出组织的成员。

获取用户
BetaOrganizationUser Beta.Organization.Users.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/users/{user_id}

按用户 ID 检索组织成员。

更新用户
BetaOrganizationUser Beta.Organization.Users.Update(parameters, cancellationToken = default)
POST/v1/organizations/users/{user_id}

更新成员的组织角色。

移除用户
UserRemoveResponse Beta.Organization.Users.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/users/{user_id}

从组织中移除成员。

Beta组织工作区

列出工作区
WorkspaceListPage Beta.Organization.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces
创建工作区
BetaWorkspace Beta.Organization.Workspaces.Create(parameters, cancellationToken = default)
POST/v1/organizations/workspaces
获取工作区
BetaWorkspace Beta.Organization.Workspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}
更新工作区
BetaWorkspace Beta.Organization.Workspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}
归档工作区
BetaWorkspace Beta.Organization.Workspaces.Archive(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/archive

Beta组织工作区速率限制

列出工作区速率限制
RateLimitListPage Beta.Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

列出为工作区配置的速率限制覆盖。

Beta组织工作区成员

列出工作区成员
MemberListPage Beta.Organization.Workspaces.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members
创建工作区成员
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members
获取工作区成员
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作区成员
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
删除工作区成员
MemberRemoveResponse Beta.Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Beta组织工作区服务账户

列出服务账户工作区成员
ServiceAccountListPage Beta.Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

创建服务账户工作区成员
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

获取服务账户工作区成员
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
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

更新服务账户工作区成员
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Update(parameters, cancellationToken = default)
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

删除服务账户工作区成员
ServiceAccountRemoveResponse Beta.Organization.Workspaces.ServiceAccounts.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

需要具有 org:admin 作用域的 OAuth 访问令牌,可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取;不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF

Beta组织速率限制

列出组织速率限制
RateLimitListPage Beta.Organization.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/rate_limits

列出您组织的 Messages API 速率限制。

Beta组织合规设置

获取合规设置
BetaComplianceSettings Beta.Organization.ComplianceSettings.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/compliance_settings

检索您组织的合规设置。

更新合规设置
BetaComplianceSettings Beta.Organization.ComplianceSettings.Update(parameters, cancellationToken = default)
POST/v1/organizations/compliance_settings

更新您组织的合规设置。