API 參考使用 API

API 概覽

Claude API 是位於 https://api.anthropic.com 的 RESTful API，提供對 Claude 模型和 Claude Managed Agents 的程式化存取。

初次使用 Claude？ 如需直接存取模型，請從開始使用和使用 Messages 著手。如需託管代理基礎架構，請參閱 Claude Managed Agents 快速入門。

先決條件

若要使用 Claude API，您需要：

一個 Claude Console 帳戶
一個 API 金鑰，或已設定的 Workload Identity Federation 規則

如需逐步設定說明，請參閱開始使用。

可用的 API

Claude API 包含以下 API：

正式發布：

Messages API：向 Claude 傳送訊息以進行對話式互動（POST /v1/messages）
Message Batches API：以非同步方式處理大量 Messages 請求，並享有 50% 的成本折扣（POST /v1/messages/batches）
Token Counting API：在傳送訊息前計算 token 數量，以管理成本和速率限制（POST /v1/messages/count_tokens）
Models API：列出可用的 Claude 模型及其詳細資訊（GET /v1/models）

Beta：

Files API：上傳和管理檔案，以便在多個 API 呼叫中使用（POST /v1/files、GET /v1/files）
Skills API：建立和管理自訂代理技能（POST /v1/skills、GET /v1/skills）
Agents API：為 Claude Managed Agents 定義可重複使用、具版本控制的代理設定（POST /v1/agents、GET /v1/agents）
Sessions API：在託管的雲端沙箱中執行具狀態的代理工作階段（POST /v1/sessions、GET /v1/sessions/{id}/stream）
Environments API：為代理工作階段設定沙箱範本（POST /v1/environments、GET /v1/environments）

如需包含所有端點、參數和回應結構描述的完整 API 參考，請瀏覽導覽列中列出的 API 參考頁面。若要存取 beta 功能，請參閱 Beta 標頭。

驗證

如需兩種驗證方法的詳細資訊以及各自的使用時機，請參閱驗證。所有對 Claude API 的請求都必須包含以下標頭：

標頭	值	必填
`x-api-key`	您從 Console 取得的 API 金鑰	`x-api-key` 或 `Authorization` 其中之一
`Authorization`	`Bearer <token>`，其中 `<token>` 是透過 Workload Identity Federation 從 `POST /v1/oauth/token` 取得的短期存取權杖	`x-api-key` 或 `Authorization` 其中之一
`anthropic-version`	API 版本（例如 `2023-06-01`）	是
`content-type`	`application/json`	是

如果您使用 Client SDK，SDK 會自動傳送這些標頭。如需 API 版本控制的詳細資訊，請參閱 API 版本。

透過雲端平台存取 Claude 時，驗證會與雲端供應商的 IAM 系統整合。請參閱平台專屬文件，以了解支援的憑證類型、必要標頭和驗證選項。

取得 API 金鑰

API 透過網頁版 Console 提供。您可以使用 Workbench 在瀏覽器中試用 API，然後在帳戶設定中產生 API 金鑰。使用工作區來區隔您的 API 金鑰，並依使用案例控制支出。

Client SDK

Anthropic 提供官方 SDK，透過處理驗證、請求格式化、錯誤處理等功能來簡化 API 整合。

優點：

自動管理標頭（x-api-key、anthropic-version、content-type）
型別安全的請求和回應處理
內建重試邏輯和錯誤處理
支援串流
請求逾時和連線管理

如需 client SDK 清單，請參閱 Client SDK。

Claude API 與雲端平台比較

Claude 可透過直接的 Claude API 和雲端平台取得。請根據您的基礎架構、功能可用性、合規要求和定價偏好進行選擇。

Claude API

直接存取最新的模型和功能
Anthropic 計費與支援
最適合： 新的整合、完整功能存取、與 Anthropic 的直接合作關係

雲端平台 API

透過 AWS、Google Cloud 或 Microsoft Azure 存取 Claude：

與雲端供應商的計費和 IAM 整合
功能可用性因平台而異： 由 Anthropic 營運的平台包括 Claude Platform on AWS 和 Microsoft Foundry；由合作夥伴營運的平台包括 Amazon Bedrock 和 Vertex AI。請參閱各平台的頁面以了解功能可用性和時程。
最適合： 現有的雲端承諾、特定的合規要求、整合的雲端計費

平台	供應商	文件
Claude Platform on AWS	AWS（由 Anthropic 營運）	Claude Platform on AWS
Amazon Bedrock	AWS	Amazon Bedrock 中的 Claude
Vertex AI	Google Cloud	Vertex AI 上的 Claude
Microsoft Foundry	Microsoft Azure（由 Anthropic 營運）	Microsoft Foundry 中的 Claude

Claude Managed Agents 可透過直接的 Claude API 和 Claude Platform on AWS 取得。如需各平台的功能可用性，請參閱功能概覽。

請求與回應格式

請求大小限制

端點	最大請求大小
Messages、Token Counting	32 MB
Message Batches API	256 MB
Files API	500 MB
Sessions、Agents、Environments	32 MB

如果超過這些限制，您將收到 413 request_too_large 錯誤。

由合作夥伴營運的平台有各自的請求大小限制：Vertex AI 將請求限制為 30 MB，Bedrock 將請求限制為 20 MB。Claude Platform on AWS 使用與直接 Claude API 相同的限制。請查閱您所使用平台的文件以取得最新數值。

回應標頭

Claude API 在每個回應中都包含以下標頭：

request-id：請求的全域唯一識別碼
anthropic-organization-id：與請求中使用的 API 金鑰相關聯的組織 ID

Claude Platform on AWS 會在標準的 request-id 標頭之外，額外加入 AWS 請求 ID（x-amzn-requestid）。請參閱請求 ID 以了解雙 ID 處理模式。

速率限制與可用性

速率限制

API 會強制執行「rate limit」（速率限制）和支出限制，以防止濫用並管理容量。限制依使用層級組織，並會隨著您使用 API 而自動提升。每個層級都有：

支出限制：API 使用的每月最高費用
速率限制：每分鐘最大請求數（RPM）和每分鐘最大 token 數（TPM）

您可以在 Console 中檢視您組織目前的限制。如需更高的限制或 Priority Tier（具承諾支出的增強服務等級），請透過 Console 聯絡銷售團隊。

如需有關限制、層級以及用於速率限制的 token bucket 演算法的詳細資訊，請參閱速率限制。

可用性

Claude API 在全球許多國家和地區皆可使用。請查看支援地區頁面以確認您所在位置的可用性。

後續步驟

Messages API 參考

直接模型互動的完整 API 規格

Claude Managed Agents 參考

Agents、Sessions 和 Environments 端點

Client SDK

Python、TypeScript、C#、Go、Java、PHP 和 Ruby

速率限制

使用層級、支出限制和 token bucket 演算法

Was this page helpful?

API 參考使用 API

API 概覽

Claude API 是位於 https://api.anthropic.com 的 RESTful API，提供對 Claude 模型和 Claude Managed Agents 的程式化存取。

初次使用 Claude？ 如需直接存取模型，請從開始使用和使用 Messages 著手。如需託管代理基礎架構，請參閱 Claude Managed Agents 快速入門。

先決條件

若要使用 Claude API，您需要：

一個 Claude Console 帳戶
一個 API 金鑰，或已設定的 Workload Identity Federation 規則

如需逐步設定說明，請參閱開始使用。

可用的 API

Claude API 包含以下 API：

正式發布：

Messages API：向 Claude 傳送訊息以進行對話式互動（POST /v1/messages）
Message Batches API：以非同步方式處理大量 Messages 請求，並享有 50% 的成本折扣（POST /v1/messages/batches）
Token Counting API：在傳送訊息前計算 token 數量，以管理成本和速率限制（POST /v1/messages/count_tokens）
Models API：列出可用的 Claude 模型及其詳細資訊（GET /v1/models）

Beta：

Files API：上傳和管理檔案，以便在多個 API 呼叫中使用（POST /v1/files、GET /v1/files）
Skills API：建立和管理自訂代理技能（POST /v1/skills、GET /v1/skills）
Agents API：為 Claude Managed Agents 定義可重複使用、具版本控制的代理設定（POST /v1/agents、GET /v1/agents）
Sessions API：在託管的雲端沙箱中執行具狀態的代理工作階段（POST /v1/sessions、GET /v1/sessions/{id}/stream）
Environments API：為代理工作階段設定沙箱範本（POST /v1/environments、GET /v1/environments）

如需包含所有端點、參數和回應結構描述的完整 API 參考，請瀏覽導覽列中列出的 API 參考頁面。若要存取 beta 功能，請參閱 Beta 標頭。

驗證

如需兩種驗證方法的詳細資訊以及各自的使用時機，請參閱驗證。所有對 Claude API 的請求都必須包含以下標頭：

標頭	值	必填
`x-api-key`	您從 Console 取得的 API 金鑰	`x-api-key` 或 `Authorization` 其中之一
`Authorization`	`Bearer <token>`，其中 `<token>` 是透過 Workload Identity Federation 從 `POST /v1/oauth/token` 取得的短期存取權杖	`x-api-key` 或 `Authorization` 其中之一
`anthropic-version`	API 版本（例如 `2023-06-01`）	是
`content-type`	`application/json`	是

如果您使用 Client SDK，SDK 會自動傳送這些標頭。如需 API 版本控制的詳細資訊，請參閱 API 版本。

透過雲端平台存取 Claude 時，驗證會與雲端供應商的 IAM 系統整合。請參閱平台專屬文件，以了解支援的憑證類型、必要標頭和驗證選項。

取得 API 金鑰

Client SDK

Anthropic 提供官方 SDK，透過處理驗證、請求格式化、錯誤處理等功能來簡化 API 整合。

優點：

自動管理標頭（x-api-key、anthropic-version、content-type）
型別安全的請求和回應處理
內建重試邏輯和錯誤處理
支援串流
請求逾時和連線管理

如需 client SDK 清單，請參閱 Client SDK。

Claude API 與雲端平台比較

Claude 可透過直接的 Claude API 和雲端平台取得。請根據您的基礎架構、功能可用性、合規要求和定價偏好進行選擇。

Claude API

直接存取最新的模型和功能
Anthropic 計費與支援
最適合： 新的整合、完整功能存取、與 Anthropic 的直接合作關係

雲端平台 API

透過 AWS、Google Cloud 或 Microsoft Azure 存取 Claude：

與雲端供應商的計費和 IAM 整合
功能可用性因平台而異： 由 Anthropic 營運的平台包括 Claude Platform on AWS 和 Microsoft Foundry；由合作夥伴營運的平台包括 Amazon Bedrock 和 Vertex AI。請參閱各平台的頁面以了解功能可用性和時程。
最適合： 現有的雲端承諾、特定的合規要求、整合的雲端計費

平台	供應商	文件
Claude Platform on AWS	AWS（由 Anthropic 營運）	Claude Platform on AWS
Amazon Bedrock	AWS	Amazon Bedrock 中的 Claude
Vertex AI	Google Cloud	Vertex AI 上的 Claude
Microsoft Foundry	Microsoft Azure（由 Anthropic 營運）	Microsoft Foundry 中的 Claude

Claude Managed Agents 可透過直接的 Claude API 和 Claude Platform on AWS 取得。如需各平台的功能可用性，請參閱功能概覽。

請求與回應格式

請求大小限制

端點	最大請求大小
Messages、Token Counting	32 MB
Message Batches API	256 MB
Files API	500 MB
Sessions、Agents、Environments	32 MB

如果超過這些限制，您將收到 413 request_too_large 錯誤。

回應標頭

Claude API 在每個回應中都包含以下標頭：

request-id：請求的全域唯一識別碼
anthropic-organization-id：與請求中使用的 API 金鑰相關聯的組織 ID

Claude Platform on AWS 會在標準的 request-id 標頭之外，額外加入 AWS 請求 ID（x-amzn-requestid）。請參閱請求 ID 以了解雙 ID 處理模式。

速率限制與可用性

速率限制

API 會強制執行「rate limit」（速率限制）和支出限制，以防止濫用並管理容量。限制依使用層級組織，並會隨著您使用 API 而自動提升。每個層級都有：

支出限制：API 使用的每月最高費用
速率限制：每分鐘最大請求數（RPM）和每分鐘最大 token 數（TPM）

您可以在 Console 中檢視您組織目前的限制。如需更高的限制或 Priority Tier（具承諾支出的增強服務等級），請透過 Console 聯絡銷售團隊。

如需有關限制、層級以及用於速率限制的 token bucket 演算法的詳細資訊，請參閱速率限制。

可用性

Claude API 在全球許多國家和地區皆可使用。請查看支援地區頁面以確認您所在位置的可用性。

後續步驟

Messages API 參考

直接模型互動的完整 API 規格

Claude Managed Agents 參考

Agents、Sessions 和 Environments 端點

Client SDK

Python、TypeScript、C#、Go、Java、PHP 和 Ruby

速率限制

使用層級、支出限制和 token bucket 演算法

Was this page helpful?

先決條件

可用的 API

驗證

取得 API 金鑰

Client SDK

Claude API 與雲端平台比較

Claude API

雲端平台 API

請求與回應格式

請求大小限制

回應標頭

速率限制與可用性

速率限制

可用性

後續步驟

先決條件

可用的 API

驗證

取得 API 金鑰

Client SDK

Claude API 與雲端平台比較

Claude API

雲端平台 API

請求與回應格式

請求大小限制

回應標頭

速率限制與可用性

速率限制

可用性

後續步驟

先決條件

可用的 API

驗證

取得 API 金鑰

Client SDK

Claude API 與雲端平台比較

Claude API

雲端平台 API

請求與回應格式

請求大小限制

回應標頭

速率限制與可用性

速率限制

可用性

後續步驟

先決條件

可用的 API

驗證

取得 API 金鑰

Client SDK

Claude API 與雲端平台比較

Claude API

雲端平台 API

請求與回應格式

請求大小限制

回應標頭

速率限制與可用性

速率限制

可用性

後續步驟