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 API，您需要：
有关分步设置说明，请参阅快速入门。
Claude API 包括以下 API：
正式发布：
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}/events/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 通过 Web 端的 Console 提供。您可以使用 Workbench 在浏览器中试用 API，然后在账户设置中生成 API 密钥。创建密钥时，您可以为每个密钥选择过期时间。使用工作区来划分您的 API 密钥，并按用例控制支出。
Anthropic 提供官方 SDK，通过处理身份验证、请求格式化、错误处理等来简化 API 集成。
优势：
有关客户端 SDK 的列表，请参阅客户端 SDK。
Claude 可通过直接的 Claude API 以及云平台访问。请根据您的基础设施、功能可用性、合规要求和定价偏好进行选择。
通过 AWS、Google Cloud 或 Microsoft Azure 访问 Claude：
| 平台 | 提供商 | 文档 |
|---|---|---|
| Agent Platform | Google Cloud | Google Cloud 上的 Claude |
| Amazon Bedrock | AWS | Amazon Bedrock 中的 Claude |
| Claude Platform on AWS | AWS（Anthropic 运营） | Claude Platform on AWS |
| Microsoft Foundry | Microsoft Azure（Anthropic 运营） | Microsoft Foundry 中的 Claude |
| 端点 | 最大请求大小 |
|---|---|
| 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列表端点以分页形式返回结果。大多数较新的列表端点使用本节描述的 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。
API 实施速率限制和支出限制，以防止滥用并管理容量。限制按使用层级组织；您的组织会被自动分配到某个层级，并可随时间推移升级到更高层级。每个层级具有：
您可以在 Console 的速率限制页面查看您的速率限制，在账单页面查看您的支出限制。如需更高的速率限制或更高的每月支出上限，请在速率限制页面使用申请提高速率限制。
有关限制、层级以及用于速率限制的令牌桶算法的详细信息，请参阅速率限制。
Claude API 在全球众多国家和地区可用。请查看支持的地区页面以确认您所在位置的可用性。
直接模型交互的完整 API 规范
Agents、Sessions 和 Environments 端点
Python、TypeScript、C#、Go、Java、PHP 和 Ruby
使用层级、申请更高限制以及令牌桶算法
Was this page helpful?