Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Claude API 是位於 https://api.anthropic.com 的 RESTful API，提供對 Claude 模型和 Claude Managed Agents 的程式化存取。
初次使用 Claude？ 若要直接存取模型，請從開始使用和使用 Messages開始。若需要受管理的代理基礎設施，請參閱 Claude Managed Agents 快速入門。
若要使用 Claude API，您需要：
如需逐步設定說明，請參閱開始使用。
Claude API 包含以下 API：
正式版（General Availability）：
POST /v1/messages）POST /v1/messages/batches）POST /v1/messages/count_tokens）GET /v1/models）Beta：
POST /v1/files、GET /v1/files）POST /v1/skills、GET /v1/skills）POST /v1/agents、GET /v1/agents）POST /v1/sessions、GET /v1/sessions/{id}/stream）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 | 是 |
如果您使用用戶端 SDK，SDK 會自動傳送這些標頭。如需 API 版本控制的詳細資訊，請參閱 API 版本。
透過雲端平台存取 Claude 時，驗證會與雲端供應商的 IAM 系統整合。請參閱各平台的專屬文件，以了解支援的憑證類型、必要標頭和驗證選項。
API 透過網頁版 Console 提供。您可以使用 Workbench 在瀏覽器中試用 API，然後在帳戶設定中產生 API 金鑰。您可以在建立每個金鑰時選擇其到期時間。使用工作區依使用案例區隔您的 API 金鑰並控制支出。
Anthropic 提供官方 SDK，透過處理驗證、請求格式化、錯誤處理等，簡化 API 整合。
優點：
如需用戶端 SDK 清單，請參閱用戶端 SDK。
Claude 可透過直接的 Claude API 和雲端平台取得。請根據您的基礎設施、功能可用性、合規要求和定價偏好進行選擇。
透過 AWS、Google Cloud 或 Microsoft Azure 存取 Claude：
| 平台 | 供應商 | 文件 |
|---|---|---|
| Agent Platform | Google Cloud | Claude on Google Cloud |
| Amazon Bedrock | AWS | Claude in Amazon Bedrock |
| Claude Platform on AWS | AWS（由 Anthropic 營運） | Claude Platform on AWS |
| Microsoft Foundry | Microsoft Azure（由 Anthropic 營運） | Claude in Microsoft Foundry |
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 錯誤。
由合作夥伴營運的平台有各自的請求大小限制：Bedrock 將請求限制為 20 MB，Google Cloud 將請求限制為 30 MB。Claude Platform on AWS 使用與直接 Claude API 相同的限制。請查閱您平台的文件以取得目前的數值。
Claude API 在每個回應中都包含以下標頭：
request-id：請求的全域唯一識別碼anthropic-organization-id：與請求中使用的 API 金鑰相關聯的組織 IDClaude Platform on AWS 會在標準的 request-id 標頭之外，額外加入一個 AWS 請求 ID（x-amzn-requestid）。請參閱請求 ID 以了解雙 ID 處理模式。
列表端點會以分頁方式回傳結果。大多數較新的列表端點使用本節所述的 page 和 next_page 游標機制。有些端點使用不同的機制；請參閱本節結尾的注意事項。使用 limit 查詢參數來控制頁面大小，並使用 page 查詢參數來擷取相鄰的頁面。每個回應都包含一個 data 陣列，以及用於在頁面之間導覽的游標欄位。
| 名稱 | 位置 | 說明 |
|---|---|---|
limit | 查詢參數 | 每頁回傳的最大項目數。 |
page | 查詢參數 | 來自先前回應的不透明游標。在此傳入 next_page 或 prev_page 的值以擷取相鄰的頁面。 |
order | 查詢參數 | 結果的排序方向（asc 或 desc），適用於支援排序的列表端點。page 游標僅在與其建立時所用的 order 相同時才有效。 |
next_page | 回應欄位 | 下一頁的游標，如果沒有更多結果則為 null。 |
prev_page | 回應欄位 | 在支援向後分頁的端點（目前為 GET /v1/sessions）上，上一頁的游標；如果您位於第一頁則為 null。其他列表端點會省略此欄位。 |
若要返回上一頁，請將 prev_page 作為 page 參數傳入。當您位於第一頁時，prev_page 為 null。並非所有列表端點都支援 prev_page。只有 GET /v1/sessions 會回傳 prev_page；在不支援向後分頁的列表端點上，回應中不會出現此欄位，而非回傳 null。如需請求的逐步說明，請參閱列出工作階段。
每個 SDK 都提供自動分頁的迭代器，會為您自動追蹤 next_page。在 Python 和 TypeScript 中，您可以直接迭代列表結果來取得它。其他 SDK 則透過獨立的方法提供迭代器。SDK 的自動分頁僅支援向前；若要返回上一頁，請從回應中讀取 prev_page，並自行將其作為 page 參數傳回。如需各語言的詳細資訊，請參閱用戶端 SDK。
有些列表端點使用不同的游標機制。Message Batches API、Files API、Models API 以及數個 Admin API 端點使用 after_id 和 before_id 查詢參數，而非 page。它們的回應會回傳 has_more、first_id 和 last_id，而非 next_page。有些使用 page 機制的端點（例如 GET /v1/skills）也會在 next_page 之外回傳一個 has_more 布林值。請參閱各端點的參考頁面以了解其確切的分頁欄位。
API 會強制執行速率限制（rate limit）和支出限制，以防止濫用並管理容量。限制依使用層級組織；您的組織會自動被分配到某個層級，並可隨時間提升至更高的層級。每個層級都有：
您可以在 Console 中檢視您組織目前的限制。若需要更高的限制，請在限制頁面上使用請求提高速率限制。
如需有關限制、層級以及用於速率限制的 token bucket 演算法的詳細資訊，請參閱速率限制。
Claude API 在全球許多國家和地區提供服務。請查看支援地區頁面以確認您所在位置的可用性。
直接模型互動的完整 API 規格
Agents、Sessions 和 Environments 端點
Python、TypeScript、C#、Go、Java、PHP 和 Ruby
使用層級、請求更高的限制，以及 token bucket 演算法
Was this page helpful?