API 参考支持与配置

版本

Copy page



在发出 API 请求时，您必须发送 anthropic-version 请求头。例如，anthropic-version: 2026-10-21。如果您使用的是客户端 SDK，这将自动为您处理。

对于任何给定的 API 版本，Anthropic 会保留：

• 现有的输入参数
• 现有的输出参数

但是，Anthropic 可能会执行以下操作：

• 添加额外的可选输入
• 向输出中添加额外的值
• 更改特定错误类型的触发条件
• 向类枚举的输出值添加新的变体（例如，流式传输事件类型）

一般而言，如果您按照本参考文档中所述的方式使用 API，Anthropic 不会破坏您的使用方式。

版本历史

Anthropic 建议尽可能使用最新的 API 版本。

• 2026-10-21
  • 迁移到 API 版本 2026-10-21 介绍了如何升级。
  • 可在 Claude API、Claude Platform on AWS、Claude Models on Google Cloud (Anthropic managed)、Microsoft Foundry 和 Claude Models on Google Cloud (Google managed) 上使用。在 Amazon Bedrock 上，它适用于 Claude 4.7 及更高版本的模型。对于 Bedrock 上的其他模型，请参阅 API 版本 2026-10-21 迁移指南。
  • Messages API：
    • 将 document 块直接放在 assistant 消息中的请求会返回 400 错误。
    • 在 user 消息中发送带有非空 citations 数组的 text 块（无论是直接发送还是放在 search_result 块内）都会返回 400 错误。
    • temperature、top_p 和 top_k 请求参数已被移除。发送其中任何一个参数的请求在所有模型上都会返回 400 错误。
  • Admin API：
    • RBAC 组可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。不再返回 roles。请改用 role_ids。
    • RBAC 组成员可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。以及移除成员时的响应不再返回 group_id。请改用 rbac_group_id。
    • RBAC 角色可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。不再返回 name。请改用 display_name。
    • 组织可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。和工作区可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。的速率限制条目，以及设置工作区速率限制可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。的响应，不再返回 group_type。请改用 group.type。
    • API 密钥可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。不再返回 workspace_id。请改用 scope.workspace_id，即使对于默认工作区（Default Workspace），它也会给出工作区的真实 ID（适用于所有工作区的密钥在 scope 中没有 workspace_id）。
  • Claude Enterprise Analytics API：
    • 按用户的使用量可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。和成本可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。报告不再包含 actor.email。请改用 actor.email_address。
    • 活动摘要可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。响应不再包含 summaries。请改用 data。
• 2023-06-01
  • “streaming”（流式传输）服务器发送事件（SSE）的新格式，详见流式传输：
    • 补全内容是增量式的。例如，" Hello"、" my"、" name"、" is"、" Claude." ，而不是 " Hello"、" Hello my"、" Hello my name"、" Hello my name is"、" Hello my name is Claude."。
    • 所有事件均为命名事件，而非仅数据事件。
    • 移除了不必要的 data: [DONE] 事件。
  • 移除了响应中遗留的 exception 和 truncated 值。
• 2023-01-01：初始版本。