API 参考使用 API

API 概述

Copy page



了解 Claude API 可用的端点、身份验证标头、客户端 SDK、分页、速率限制以及云平台访问选项。

Claude API 是位于 https://api.anthropic.com 的 RESTful API，提供对 Claude 模型和 Claude Managed Agents 的编程访问。

前提条件

要使用 Claude API，您需要：

• 一个 Claude Console 账户
• 从 Console 获取的 API 密钥，或已配置的工作负载身份联合规则

有关分步设置说明，请参阅开始使用。

可用的 API

Claude API 包括以下 API：

• Messages API可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。： 向 Claude 发送消息以进行对话式交互（POST /v1/messages）
• Message Batches API可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。： 以异步方式处理大量 Messages 请求，成本降低 50%（POST /v1/messages/batches）
• Token Counting API可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。： 在发送消息之前计算其中的令牌数，以管理成本和速率限制（POST /v1/messages/count_tokens）
• Models API可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。： 列出可用的 Claude 模型及其详细信息（GET /v1/models）
• Files API可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。： 上传和管理文件，以便在多个 API 调用中使用（POST /v1/files、GET /v1/files）
• Skills API可查看包含 API 参考文档链接的预览——按 Tab 键直到焦点进入卡片，按 Escape 键返回。： 创建和管理自定义智能体技能（POST /v1/skills、GET /v1/skills）

以下 API 处于测试阶段：

• Agents API： 为 Claude Managed Agents 定义可复用、带版本的智能体配置（POST /v1/agents、GET /v1/agents）
• Sessions API： 在托管的云沙箱中运行有状态的智能体会话（POST /v1/sessions、GET /v1/sessions/{id}/events/stream）
• Environments API： 为智能体会话配置沙箱模板（POST /v1/environments、GET /v1/environments）

有关包含所有端点、参数和响应架构的完整 API 参考，请浏览导航中列出的 API 参考页面。要访问测试功能，请参阅 Beta 标头。

身份验证

有关每种身份验证方法及其使用时机的详细信息，请参阅身份验证。对 Claude API 的请求包含以下标头：

如果您使用客户端 SDK，SDK 会自动发送身份验证、版本和 content-type 标头；当您的密钥需要时，您需要自己传递 anthropic-workspace-id。有关 API 版本控制的详细信息，请参阅 API 版本。

通过云平台访问 Claude 时，身份验证与云提供商的 IAM 系统集成。有关支持的凭据类型、所需标头和身份验证选项，请参阅特定平台的文档。

获取 API 密钥

API 通过网页版 Console 提供。在 Console 中，您可以使用 Playground（platform.claude.com/playground）在浏览器中试用 API，然后在 API 密钥页面（platform.claude.com/settings/keys）生成 API 密钥。要了解具体方法，请参阅获取您的 Claude API 密钥。创建密钥时，您可以选择每个密钥的类型（请参阅密钥类型）及其过期时间。在 Console 中使用工作区来分隔环境，并按用例控制支出。

客户端 SDK

Anthropic 提供官方 SDK，通过处理身份验证、请求格式化、错误处理等来简化 API 集成。

优势：

• 自动标头管理（身份验证、anthropic-version、content-type）
• 类型安全的请求和响应处理
• 内置重试逻辑和错误处理
• 流式传输支持
• 请求超时和连接管理

有关客户端 SDK 列表，请参阅 SDK、CLI 和库。

Claude API 与云平台

Claude 可通过第一方 Claude API 和云平台使用。请根据您的基础设施、功能可用性、合规要求和定价偏好进行选择。

Claude API

• 直接访问最新的模型和功能
• Anthropic 计费和支持
• 最适合： 新集成、完整功能访问、与 Anthropic 的直接关系

云平台 API

通过 AWS、Google Cloud 或 Microsoft Azure 访问 Claude：

• 与云提供商的计费和 IAM 集成
• 功能可用性因平台而异： Anthropic 运营的平台包括 Claude Platform on AWS、Claude Models on Google Cloud (Anthropic managed) 和 Microsoft Foundry；合作伙伴运营的平台包括 Claude Models on Google Cloud (Google managed) 和 Amazon Bedrock。有关功能可用性和时间安排，请参阅每个平台的页面。
• 最适合： 现有云承诺、特定合规要求、合并云计费

请求和响应格式

请求大小限制

第一方 Claude API 强制执行以下请求大小限制：

如果超过这些限制，您将收到 413 request_too_large 错误。

响应标头

Claude API 在其响应中包含以下标头：

有关速率限制标头，请参阅速率限制中的响应标头。有关使用每个 SDK 按名称读取响应标头的示例，请参阅识别 API 响应背后的工作区。

分页

列表端点以页面形式返回结果。大多数较新的列表端点使用本节中描述的 page 和 next_page 游标方案。有些使用不同的方案；请参阅本节末尾的说明。使用 limit 查询参数控制页面大小，使用 page 查询参数获取相邻页面。每个响应都包含一个 data 数组以及用于在页面之间导航的游标字段。

要返回上一页，请将 prev_page 作为 page 参数传递。当您在第一页时，prev_page 为 null。并非所有列表端点都支持 prev_page。只有 GET /v1/sessions 返回 prev_page；在不支持向后分页的列表端点上，该字段在响应中不存在，而不是 null。有关请求演练，请参阅列出会话。

SDK 提供了一个自动分页迭代器，会替您跟随 next_page。例如，for session in client.beta.sessions.list() 会遍历每个会话。SDK 自动分页只能向前；要返回上一页，请从响应中读取 prev_page，并自行将其作为 page 参数传回。有关详细信息，请参阅 SDK、CLI 和库。

速率限制和可用性

速率限制

该 API 强制执行速率限制和支出限制，以防止滥用并管理容量。限制按使用层级组织；您的组织会自动被分配到某个层级，并可随时间推移升级到更高层级。每个层级都有：

• 支出限制： API 使用的每月最高费用
• 速率限制： 每分钟最大请求数（RPM）和每分钟最大令牌数（TPM）

您可以在 Claude Console 中的速率限制下查看您的速率限制，并在 Console 的账单页面查看您的支出限制。如需更高的速率限制或更高的每月支出上限，请在速率限制页面上使用申请提升等级。

有关限制、层级以及用于速率限制的令牌桶算法的详细信息，请参阅速率限制。

可用性

Claude API 在全球许多国家和地区可用。请查看支持的地区页面以确认您所在位置的可用性。

后续步骤