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：在发送消息之前统计令牌数量，以管理成本和速率限制（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`	是

如果您使用的是客户端 SDK，SDK 会自动发送这些标头。有关 API 版本控制的详细信息，请参阅 API 版本。

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

获取 API 密钥

API 通过 Web Console 提供。您可以使用 Workbench 在浏览器中试用 API，然后在账户设置中生成 API 密钥。使用工作区对您的 API 密钥进行分组，并按用例控制支出。

客户端 SDK

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

优势：

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

有关客户端 SDK 的列表，请参阅客户端 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 和 Google Cloud。有关功能可用性和时间安排，请参阅各平台的页面。
最适合： 现有的云承诺、特定的合规要求、统一的云计费

平台	提供商	文档
Claude Platform on AWS	AWS（Anthropic 运营）	Claude Platform on AWS
Amazon Bedrock	AWS	Amazon Bedrock 中的 Claude
Agent Platform	Google Cloud	Google Cloud 上的 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 错误。

合作伙伴运营的平台有各自的请求大小限制：Google Cloud 将请求限制为 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。

分页

列表端点以分页形式返回结果。大多数较新的列表端点使用本节中描述的 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 会强制执行速率限制和支出限制，以防止滥用并管理容量。限制按使用层级组织；您的组织会被自动分配到某个层级，并可随时间推移升级到更高层级。每个层级都有：

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

您可以在 Console 中查看您组织的当前限制。如需更高的限制，请在限制页面上使用申请提高速率限制。

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

可用性

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

后续步骤

Messages API 参考

直接模型交互的完整 API 规范

Claude Managed Agents 参考

Agents、Sessions 和 Environments 端点

客户端 SDK

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

速率限制

使用层级、申请更高限制以及令牌桶算法

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：在发送消息之前统计令牌数量，以管理成本和速率限制（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`	是

如果您使用的是客户端 SDK，SDK 会自动发送这些标头。有关 API 版本控制的详细信息，请参阅 API 版本。

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

获取 API 密钥

客户端 SDK

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

优势：

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

有关客户端 SDK 的列表，请参阅客户端 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 和 Google Cloud。有关功能可用性和时间安排，请参阅各平台的页面。
最适合： 现有的云承诺、特定的合规要求、统一的云计费

平台	提供商	文档
Claude Platform on AWS	AWS（Anthropic 运营）	Claude Platform on AWS
Amazon Bedrock	AWS	Amazon Bedrock 中的 Claude
Agent Platform	Google Cloud	Google Cloud 上的 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。

分页

名称	位置	描述
`limit`	查询参数	每页返回的最大项目数。
`page`	查询参数	来自先前响应的不透明游标。在此处传递 `next_page` 或 `prev_page` 值以获取相邻页面。
`order`	查询参数	结果的排序方向（`asc` 或 `desc`），适用于支持排序的列表端点。`page` 游标仅在创建它时所用的 `order` 下有效。
`next_page`	响应字段	下一页的游标，如果没有更多结果则为 `null`。
`prev_page`	响应字段	支持向后分页的端点（目前为 `GET /v1/sessions`）上的上一页游标，如果您位于第一页则为 `null`。其他列表端点会省略此字段。

速率限制和可用性

速率限制

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

您可以在 Console 中查看您组织的当前限制。如需更高的限制，请在限制页面上使用申请提高速率限制。

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

可用性

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

后续步骤

Messages API 参考

直接模型交互的完整 API 规范

Claude Managed Agents 参考

Agents、Sessions 和 Environments 端点

客户端 SDK

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

速率限制

使用层级、申请更高限制以及令牌桶算法

Was this page helpful?

前提条件

可用的 API

身份验证

获取 API 密钥

客户端 SDK

Claude API 与云平台对比

Claude API

云平台 API

请求和响应格式

请求大小限制

响应标头

分页

速率限制和可用性

速率限制

可用性

后续步骤

前提条件

可用的 API

身份验证

获取 API 密钥

客户端 SDK

Claude API 与云平台对比

Claude API

云平台 API

请求和响应格式

请求大小限制

响应标头

分页

速率限制和可用性

速率限制

可用性

后续步骤

前提条件

可用的 API

身份验证

获取 API 密钥

客户端 SDK

Claude API 与云平台对比

Claude API

云平台 API

请求和响应格式

请求大小限制

响应标头

分页

速率限制和可用性

速率限制

可用性

后续步骤

前提条件

可用的 API

身份验证

获取 API 密钥

客户端 SDK

Claude API 与云平台对比

Claude API

云平台 API

请求和响应格式

请求大小限制

响应标头

分页

速率限制和可用性

速率限制

可用性

后续步骤