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 鍵返回。的「rate limit」（速率限制）項目，以及設定工作區速率限制可檢視預覽，內含 API 參考文件連結——按 Tab 鍵直到焦點進入卡片，按 Escape 鍵返回。的回應，不再傳回 group_type。請改用 group.type。
    • API 金鑰可檢視預覽，內含 API 參考文件連結——按 Tab 鍵直到焦點進入卡片，按 Escape 鍵返回。不再傳回 workspace_id。請改用 scope.workspace_id，即使是預設工作區，它也會提供工作區的真實 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
  • 串流「server-sent events」（伺服器傳送事件），即 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：初始版本。