Claude Platform Docs

Beta

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

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

Beta模型

列出模型
GET/v1/models

列出可用模型。

获取模型
GET/v1/models/{model_id}

获取特定模型。

Beta消息

创建消息
POST/v1/messages

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

计算消息中的令牌数
POST/v1/messages/count_tokens

计算消息中的令牌数量。

Beta消息批处理

创建消息批次
POST/v1/messages/batches

发送一批消息创建请求。

检索消息批次
GET/v1/messages/batches/{message_batch_id}

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

列出消息批次
GET/v1/messages/batches

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

取消消息批次
POST/v1/messages/batches/{message_batch_id}/cancel

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

删除消息批次
DELETE/v1/messages/batches/{message_batch_id}

删除消息批次。

检索消息批次结果
GET/v1/messages/batches/{message_batch_id}/results

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

Beta代理

创建代理
POST/v1/agents
列出代理
GET/v1/agents
获取代理
GET/v1/agents/{agent_id}
更新代理
POST/v1/agents/{agent_id}
归档代理
POST/v1/agents/{agent_id}/archive

Beta代理版本

列出代理版本
GET/v1/agents/{agent_id}/versions

Beta环境

创建环境
POST/v1/environments

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

列出环境
GET/v1/environments

列出环境，支持分页。

获取环境
GET/v1/environments/{environment_id}

按 ID 检索特定环境。

更新环境
POST/v1/environments/{environment_id}

更新现有环境的配置。

删除环境
DELETE/v1/environments/{environment_id}

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

归档环境
POST/v1/environments/{environment_id}/archive

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

Beta环境工作

获取工作项
GET/v1/environments/{environment_id}/work/{work_id}

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

轮询工作
GET/v1/environments/{environment_id}/work/poll

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

确认工作
POST/v1/environments/{environment_id}/work/{work_id}/ack

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

记录心跳
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

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

停止工作
POST/v1/environments/{environment_id}/work/{work_id}/stop

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

列出工作项
GET/v1/environments/{environment_id}/work

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

更新工作项
POST/v1/environments/{environment_id}/work/{work_id}

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

获取队列统计信息
GET/v1/environments/{environment_id}/work/stats

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

Beta会话

创建会话
POST/v1/sessions
列出会话
GET/v1/sessions
获取会话
GET/v1/sessions/{session_id}
更新会话
POST/v1/sessions/{session_id}
删除会话
DELETE/v1/sessions/{session_id}
归档会话
POST/v1/sessions/{session_id}/archive

Beta会话事件

列出事件
GET/v1/sessions/{session_id}/events
发送事件
POST/v1/sessions/{session_id}/events
流式传输事件
GET/v1/sessions/{session_id}/events/stream

Beta会话资源

添加会话资源
POST/v1/sessions/{session_id}/resources
列出会话资源
GET/v1/sessions/{session_id}/resources
获取会话资源
GET/v1/sessions/{session_id}/resources/{resource_id}
更新会话资源
POST/v1/sessions/{session_id}/resources/{resource_id}
删除会话资源
DELETE/v1/sessions/{session_id}/resources/{resource_id}

Beta会话线程

列出会话线程
GET/v1/sessions/{session_id}/threads
获取会话线程
GET/v1/sessions/{session_id}/threads/{thread_id}
归档会话线程
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

Beta会话线程事件

列出会话线程事件
GET/v1/sessions/{session_id}/threads/{thread_id}/events
流式传输会话线程事件
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

Beta部署

创建部署
POST/v1/deployments
列出部署
GET/v1/deployments
获取部署
GET/v1/deployments/{deployment_id}
更新部署
POST/v1/deployments/{deployment_id}
归档部署
POST/v1/deployments/{deployment_id}/archive
立即运行部署
POST/v1/deployments/{deployment_id}/run
暂停部署
POST/v1/deployments/{deployment_id}/pause
取消暂停部署
POST/v1/deployments/{deployment_id}/unpause

Beta部署运行

列出部署运行
GET/v1/deployment_runs
获取部署运行
GET/v1/deployment_runs/{deployment_run_id}

Beta保管库

创建保管库
POST/v1/vaults
列出保管库
GET/v1/vaults
获取保管库
GET/v1/vaults/{vault_id}
更新保管库
POST/v1/vaults/{vault_id}
删除保管库
DELETE/v1/vaults/{vault_id}
归档保管库
POST/v1/vaults/{vault_id}/archive

Beta保管库凭证

创建凭证
POST/v1/vaults/{vault_id}/credentials
列出凭证
GET/v1/vaults/{vault_id}/credentials
获取凭证
GET/v1/vaults/{vault_id}/credentials/{credential_id}
更新凭证
POST/v1/vaults/{vault_id}/credentials/{credential_id}
删除凭证
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
归档凭证
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
验证凭证
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

Beta记忆存储

创建记忆存储
POST/v1/memory_stores
列出记忆存储
GET/v1/memory_stores
检索记忆存储
GET/v1/memory_stores/{memory_store_id}
更新记忆存储
POST/v1/memory_stores/{memory_store_id}
删除记忆存储
DELETE/v1/memory_stores/{memory_store_id}
归档记忆存储
POST/v1/memory_stores/{memory_store_id}/archive

Beta记忆存储记忆

创建记忆
POST/v1/memory_stores/{memory_store_id}/memories
列出记忆
GET/v1/memory_stores/{memory_store_id}/memories
检索记忆
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
更新记忆
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
删除记忆
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

Beta记忆存储记忆版本

列出记忆版本
GET/v1/memory_stores/{memory_store_id}/memory_versions
检索记忆版本
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
对记忆版本进行脱敏
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

Beta文件

上传文件
POST/v1/files
列出文件
GET/v1/files
下载文件
GET/v1/files/{file_id}/content
获取文件元数据
GET/v1/files/{file_id}
删除文件
DELETE/v1/files/{file_id}

Beta技能

创建技能
POST/v1/skills
列出技能
GET/v1/skills
获取技能
GET/v1/skills/{skill_id}
删除技能
DELETE/v1/skills/{skill_id}

Beta技能版本

创建技能版本
POST/v1/skills/{skill_id}/versions
列出技能版本
GET/v1/skills/{skill_id}/versions
下载技能版本内容
GET/v1/skills/{skill_id}/versions/{version}/content

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

获取技能版本
GET/v1/skills/{skill_id}/versions/{version}
删除技能版本
DELETE/v1/skills/{skill_id}/versions/{version}

Beta用户配置文件

创建用户配置文件
POST/v1/user_profiles
列出用户配置文件
GET/v1/user_profiles
获取用户配置文件
GET/v1/user_profiles/{user_profile_id}
更新用户配置文件
POST/v1/user_profiles/{user_profile_id}
创建注册 URL
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDream

创建 Dream
POST/v1/dreams

启动一个异步作业，该作业使用过去的会话生成记忆存储的重组版本，并返回 dream 以供您轮询结果。

列出 Dream
GET/v1/dreams

按从新到旧的顺序列出工作区中的 dream。

获取 Dream
GET/v1/dreams/{dream_id}

通过 ID 获取 dream，以检查其状态、输出记忆存储和令牌用量。

取消 Dream
POST/v1/dreams/{dream_id}/cancel

停止处于 pending 或 running 状态的 dream。

归档 Dream
POST/v1/dreams/{dream_id}/archive

将处于 completed、failed 或 canceled 状态的 dream 从默认 dream 列表中隐藏。

Beta隧道

创建隧道
POST/v1/tunnels

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

获取隧道
GET/v1/tunnels/{tunnel_id}

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

列出隧道
GET/v1/tunnels

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

归档隧道
POST/v1/tunnels/{tunnel_id}/archive

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

显示隧道令牌
POST/v1/tunnels/{tunnel_id}/reveal_token

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

轮换隧道令牌
POST/v1/tunnels/{tunnel_id}/rotate_token

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

Beta隧道证书

创建隧道证书
POST/v1/tunnels/{tunnel_id}/certificates

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

获取隧道证书
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

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

列出隧道证书
GET/v1/tunnels/{tunnel_id}/certificates

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

归档隧道证书
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

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

Beta组织

获取当前组织
GET/v1/organizations/me

检索与经过身份验证的 API 密钥关联的组织的信息。

Beta组织API 密钥

列出 API 密钥
GET/v1/organizations/api_keys
检索 API 密钥（Admin API）
GET/v1/organizations/api_keys/{api_key_id}

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

更新 API 密钥
POST/v1/organizations/api_keys/{api_key_id}

Beta组织外部密钥

创建外部密钥
POST/v1/organizations/external_keys

创建一个归调用方组织所有的外部密钥配置。

列出外部密钥
GET/v1/organizations/external_keys

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

获取外部密钥
GET/v1/organizations/external_keys/{external_key_id}

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

更新外部密钥
POST/v1/organizations/external_keys/{external_key_id}

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

删除外部密钥
DELETE/v1/organizations/external_keys/{external_key_id}

删除外部密钥配置。

验证外部密钥
POST/v1/organizations/external_keys/{external_key_id}/validate

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

Beta组织联合颁发者

创建联合颁发者
POST/v1/organizations/federation_issuers

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

列出联合颁发者
GET/v1/organizations/federation_issuers

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

获取联合颁发者
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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

更新联合颁发者
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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

归档联合颁发者
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

Beta组织联合规则

创建联合规则
POST/v1/organizations/federation_rules

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

列出联合规则
GET/v1/organizations/federation_rules

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

获取联合规则
GET/v1/organizations/federation_rules/{federation_rule_id}

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

更新联合规则
POST/v1/organizations/federation_rules/{federation_rule_id}

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

归档联合规则
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

Beta组织联合规则工作区

添加联合规则工作区
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

列出联合规则工作区
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

移除联合规则工作区
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组织邀请

创建邀请
POST/v1/organizations/invites

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

列出邀请
GET/v1/organizations/invites

列出组织的邀请。

获取邀请
GET/v1/organizations/invites/{invite_id}

按 ID 检索邀请。

删除邀请
DELETE/v1/organizations/invites/{invite_id}

删除待处理的邀请。

Beta组织服务账号

创建服务账号
POST/v1/organizations/service_accounts

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

列出服务账号
GET/v1/organizations/service_accounts

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

获取服务账号
GET/v1/organizations/service_accounts/{service_account_id}

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

更新服务账号
POST/v1/organizations/service_accounts/{service_account_id}

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

归档服务账号
POST/v1/organizations/service_accounts/{service_account_id}/archive

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

Beta组织服务账号工作区

将工作区添加到服务账号
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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

列出服务账号所属的工作区
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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

从服务账号中移除工作区
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组织用户

列出用户
GET/v1/organizations/users

列出组织的成员。

获取用户
GET/v1/organizations/users/{user_id}

按用户 ID 检索组织成员。

更新用户
POST/v1/organizations/users/{user_id}

更新成员的组织角色。

移除用户
DELETE/v1/organizations/users/{user_id}

将成员从组织中移除。

Beta组织工作区

列出工作区
GET/v1/organizations/workspaces
创建工作区
POST/v1/organizations/workspaces
获取工作区
GET/v1/organizations/workspaces/{workspace_id}
更新工作区
POST/v1/organizations/workspaces/{workspace_id}
归档工作区
POST/v1/organizations/workspaces/{workspace_id}/archive

Beta组织工作区速率限制

列出工作区速率限制
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

列出工作区的速率限制（rate limit）。

Beta组织工作区成员

列出工作区成员
GET/v1/organizations/workspaces/{workspace_id}/members
创建工作区成员
POST/v1/organizations/workspaces/{workspace_id}/members
获取工作区成员
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作区成员
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
删除工作区成员
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Beta组织工作区服务账号

列出服务账号工作区成员
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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

创建服务账号工作区成员
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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

获取服务账号工作区成员
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。

更新服务账号工作区成员
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。

删除服务账号工作区成员
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组织速率限制

列出组织速率限制
GET/v1/organizations/rate_limits

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

Beta组织合规设置

获取合规设置
GET/v1/organizations/compliance_settings

检索您组织的合规设置。

更新合规设置
POST/v1/organizations/compliance_settings

更新您组织的合规设置。

Beta组织使用情况报告

获取 Messages 使用情况报告
GET/v1/organizations/usage_report/messages
获取 Claude Code 使用情况报告
GET/v1/organizations/usage_report/claude_code

检索 Claude Code 用户的每日汇总使用指标。 使组织能够分析开发者生产力并构建自定义仪表板。

Beta组织成本报告

获取成本报告
GET/v1/organizations/cost_report

Beta组织MCP 隧道

列出隧道
Deprecated
GET/v1/organizations/tunnels

已弃用。此 Admin API 端点已被 Claude API 上的 /v1/tunnels 取代，并将在迁移窗口期后移除。新集成应使用 /v1/tunnels，并附带 anthropic-beta: mcp-tunnels-2026-06-22 标头和携带 workspace:manage_tunnels 范围的 WIF 令牌。在迁移窗口期内，现有集成可继续使用 mcp-tunnels-2026-05-19 标头和 org:manage_tunnels 范围。

获取隧道
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}

已弃用。 此 Admin API 端点已被 Claude API 上的 /v1/tunnels 取代，并将在迁移窗口期后移除。新集成应使用 /v1/tunnels，并附带 anthropic-beta: mcp-tunnels-2026-06-22 标头和携带 workspace:manage_tunnels 范围的 WIF 令牌。在迁移窗口期内，现有集成可继续使用 mcp-tunnels-2026-05-19 标头和 org:manage_tunnels 范围。

归档隧道
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive

已弃用。 此 Admin API 端点已被 Claude API 上的 /v1/tunnels 取代，并将在迁移窗口期后移除。新集成应使用 /v1/tunnels，并附带 anthropic-beta: mcp-tunnels-2026-06-22 标头和携带 workspace:manage_tunnels 范围的 WIF 令牌。在迁移窗口期内，现有集成可继续使用 mcp-tunnels-2026-05-19 标头和 org:manage_tunnels 范围。

显示隧道令牌
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token

已弃用。此 Admin API 端点已被 Claude API 上的 /v1/tunnels 取代，并将在迁移窗口期后移除。新集成应使用 /v1/tunnels，并附带 anthropic-beta: mcp-tunnels-2026-06-22 标头和携带 workspace:manage_tunnels 范围的 WIF 令牌。在迁移窗口期内，现有集成可继续使用 mcp-tunnels-2026-05-19 标头和 org:manage_tunnels 范围。

轮换隧道令牌
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token

已弃用。此 Admin API 端点已被 Claude API 上的 /v1/tunnels 取代，并将在迁移窗口期后移除。新集成应使用 /v1/tunnels，并附带 anthropic-beta: mcp-tunnels-2026-06-22 标头和携带 workspace:manage_tunnels 范围的 WIF 令牌。在迁移窗口期内，现有集成可继续使用 mcp-tunnels-2026-05-19 标头和 org:manage_tunnels 范围。

Beta组织MCP 隧道隧道证书

创建隧道证书
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates

已弃用。 此 Admin API 端点已被 Claude API 上的 /v1/tunnels 取代，并将在迁移窗口期后移除。新集成应使用 /v1/tunnels，并附带 anthropic-beta: mcp-tunnels-2026-06-22 标头和携带 workspace:manage_tunnels 范围的 WIF 令牌。在迁移窗口期内，现有集成可继续使用 mcp-tunnels-2026-05-19 标头和 org:manage_tunnels 范围。

列出隧道证书
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates

已弃用。此 Admin API 端点已被 Claude API 上的 /v1/tunnels 取代，并将在迁移窗口期后移除。新集成应使用 /v1/tunnels，并附带 anthropic-beta: mcp-tunnels-2026-06-22 标头和携带 workspace:manage_tunnels 范围的 WIF 令牌。在迁移窗口期内，现有集成可继续使用 mcp-tunnels-2026-05-19 标头和 org:manage_tunnels 范围。

获取隧道证书
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}

已弃用。 此 Admin API 端点已被 Claude API 上的 /v1/tunnels 取代，并将在迁移窗口期后移除。新集成应使用 /v1/tunnels，并附带 anthropic-beta: mcp-tunnels-2026-06-22 标头和携带 workspace:manage_tunnels 范围的 WIF 令牌。在迁移窗口期内，现有集成可继续使用 mcp-tunnels-2026-05-19 标头和 org:manage_tunnels 范围。

归档隧道证书
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

已弃用。 此 Admin API 端点已被 Claude API 上的 /v1/tunnels 取代，并将在迁移窗口期结束后移除。新的集成应使用 /v1/tunnels，并附带 anthropic-beta: mcp-tunnels-2026-06-22 请求头以及携带 workspace:manage_tunnels 作用域的 WIF 令牌。在迁移窗口期内，现有集成可继续使用 mcp-tunnels-2026-05-19 请求头和 org:manage_tunnels 作用域正常工作。

Beta组织分析摘要

获取活动摘要
GET/v1/organizations/analytics/summaries

获取某个日期范围内的组织级活动摘要。

Beta组织分析用户

列出用户活动
GET/v1/organizations/analytics/users

获取给定日期的每用户活动，支持基于游标的分页。

Beta组织分析应用聊天项目

获取聊天项目用量
GET/v1/organizations/analytics/apps/chat/projects

获取指定日期的每项目活动，支持基于游标的分页。

Beta组织分析连接器

获取连接器使用情况
GET/v1/organizations/analytics/connectors

获取给定日期的每连接器使用情况，支持基于游标的分页。

Beta组织分析插件

获取插件使用情况
GET/v1/organizations/analytics/plugins

获取给定日期的每插件安装 + 调用使用情况，支持分页。

Beta组织分析技能

获取技能使用情况
GET/v1/organizations/analytics/skills

获取给定日期的每技能使用情况，支持基于游标的分页。

Beta组织分析Artifacts

获取 Artifact 活动
GET/v1/organizations/analytics/artifacts

获取给定日期的 Artifact 创建活动，按 MIME 类型细分。

Beta组织分析使用情况报告

获取随时间变化的令牌用量
GET/v1/organizations/analytics/usage_report

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

Beta组织分析用户用量报告

获取每用户令牌用量
GET/v1/organizations/analytics/user_usage_report

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

Beta组织分析成本报告

获取随时间变化的成本
GET/v1/organizations/analytics/cost_report

获取某个日期范围内随时间变化的成本（以美元计）。

Beta组织分析用户成本报告

获取每用户成本
GET/v1/organizations/analytics/user_cost_report

获取某个日期范围内的每用户成本（以美元计）。

Beta组织支出限额

设置支出限额
POST/v1/organizations/spend_limits

设置支出限额。

获取支出限额
GET/v1/organizations/spend_limits/{spend_limit_id}

按 ID 检索支出限额。

删除支出限额
DELETE/v1/organizations/spend_limits/{spend_limit_id}

删除支出限额。

列出支出限额
GET/v1/organizations/spend_limits

列出组织的支出限额。

Beta组织支出限额生效

列出生效的支出限额
GET/v1/organizations/spend_limits/effective

列出每位成员的生效支出限额及本周期至今的支出。

Beta组织支出限额提额请求

列出支出限额提额请求
GET/v1/organizations/spend_limit_increase_requests

列出支出限额提额请求，最新的在前。

获取支出限额提额请求
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

检索支出限额提额请求。

批准支出限额提额请求
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

批准待处理的支出限额提额请求。

拒绝支出限额提额请求
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

拒绝待处理的支出限额提额请求。

Beta组织RBAC 组

创建 RBAC 组
POST/v1/organizations/rbac_groups

在 Claude Enterprise 租户中创建 RBAC 组。通过 API 创建的组的来源类型为 "direct"。

列出 RBAC 组
GET/v1/organizations/rbac_groups

列出 Claude Enterprise 租户中的 RBAC 组。

获取 RBAC 组
GET/v1/organizations/rbac_groups/{rbac_group_id}

按 ID 检索 RBAC 组。

更新 RBAC 组
POST/v1/organizations/rbac_groups/{rbac_group_id}

更新 RBAC 组的名称。当租户中的某个组织使用 SCIM 预配时，由身份提供商预配的组（来源类型为 "scim"）无法通过 API 修改。

删除 RBAC 组
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

删除 RBAC 组。当租户中的某个组织使用 SCIM 预配时，由身份提供商预配的组（来源类型为 "scim"）无法通过 API 删除。

Beta组织RBAC 组成员

列出 RBAC 组成员
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

列出 RBAC 组的成员。

添加 RBAC 组成员
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

将用户添加到 RBAC 组。当租户中的某个组织使用 SCIM 预配时，由身份提供商预配的组（来源类型为 "scim"）的成员资格无法通过 API 修改。

移除 RBAC 组成员
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

从 RBAC 组中移除用户。当租户中的某个组织使用 SCIM 预配时，由身份提供商预配的组（来源类型为 "scim"）的成员资格无法通过 API 修改。

Beta组织RBAC 角色

列出 RBAC 角色
GET/v1/organizations/rbac_roles

列出组织中的 RBAC 角色。

获取 RBAC 角色
GET/v1/organizations/rbac_roles/{rbac_role_id}

按 ID 检索 RBAC 角色。

Beta组织RBAC 角色权限

列出 RBAC 角色权限
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

列出 RBAC 角色授予的权限。

Beta组织插件

创建插件
POST/v1/organizations/plugins

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

获取插件
GET/v1/organizations/plugins/{plugin_id}

按 ID 检索插件。

更新插件
POST/v1/organizations/plugins/{plugin_id}

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

列出插件
GET/v1/organizations/plugins

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

删除插件
DELETE/v1/organizations/plugins/{plugin_id}

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

Beta组织插件版本

创建插件版本
POST/v1/organizations/plugins/{plugin_id}/versions

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

列出插件版本
GET/v1/organizations/plugins/{plugin_id}/versions

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

获取插件版本
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

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

下载插件版本归档
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

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

Beta组织插件安装设置

列出插件安装设置
GET/v1/organizations/plugins/{plugin_id}/installation_settings

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

设置插件安装设置
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

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

移除插件安装设置
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

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

Beta组织插件共享

列出插件共享
GET/v1/organizations/plugins/{plugin_id}/shares

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

Beta组织插件市场

列出插件市场
GET/v1/organizations/plugin_marketplaces

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

获取插件市场
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

按 ID 检索插件市场。

更新插件市场
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

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

验证插件市场代码仓库
POST/v1/organizations/plugin_marketplaces/validate_repository

检查存放在公共 GitHub 代码仓库中的插件市场能否同步到 claude.ai，而不会连接或存储该市场。

验证插件市场归档
POST/v1/organizations/plugin_marketplaces/validate_archive

检查以市场目录 .zip 文件形式上传的插件市场能否同步到 claude.ai，而不会连接或存储该市场。

Beta组织遥测目标

创建遥测目标
POST/v1/organizations/telemetry_destinations

为组织注册一个 OpenTelemetry 目标。

列出遥测目标
GET/v1/organizations/telemetry_destinations

列出组织的目标，最新的排在最前，可选择仅列出覆盖指定工作区的目标。

检索遥测目标
GET/v1/organizations/telemetry_destinations/{destination_id}

读取目标的配置、状态和最近的投递结果。

更新遥测目标
POST/v1/organizations/telemetry_destinations/{destination_id}

更改遥测目标的设置、状态或其覆盖的工作区。

删除遥测目标
DELETE/v1/organizations/telemetry_destinations/{destination_id}

删除目标及其工作区列表。

测试遥测目标
POST/v1/organizations/telemetry_destinations/{destination_id}/test

使用目标已注册的标头向其发送一个名为 anthropic.test 的测试 span，仅发送一次且不重试，并报告目标的响应。无论目标是否以 2xx 状态响应，响应均为 200：其 result 的类型为 success，或类型为 failure 并在 error 中给出原因。目标的配置、state 和 delivery_health 不会改变。已禁用的目标也可以测试。对同一目标的两次测试之间请等待 10 秒；过早发出的请求可能会收到 429 状态。

Beta组织遥测目标工作区

列出遥测目标工作区
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces

列出目标工作区列表中的工作区，最新条目排在最前。

添加遥测目标工作区
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

向目标的工作区列表中添加一个工作区。

移除遥测目标工作区
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

从目标的工作区列表中移除一个工作区。