Claude Platform Docs
API 参考使用 API

API 概述

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

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

前提条件

要使用 Claude API,您需要:

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

可用的 API

Claude API 包括以下 API:

  • Messages API:向 Claude 发送消息以进行对话交互(POST /v1/messages)
  • Message Batches API:以 50% 的成本降低异步处理大量 Messages 请求(POST /v1/messages/batches)
  • Token Counting API:在发送前统计消息中的令牌数量,以管理成本和速率限制(POST /v1/messages/count_tokens)
  • Models API:列出可用的 Claude 模型及其详细信息(GET /v1/models)
  • Files API:上传和管理文件,以便在多个 API 调用中使用(POST /v1/files、GET /v1/files)
  • Skills API:创建和管理自定义代理技能(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 的请求包含以下标头:

标头值是否必需
AuthorizationBearer <token>,其中 <token> 是您的 API 密钥,或通过 Workload Identity Federation 从 POST /v1/oauth/token 获取的短期访问令牌是,除非已设置 x-api-key
x-api-key您在 Console 中获取的 API 密钥。Authorization 的旧版备用方式,仍受支持否
anthropic-workspace-id请求所运行的工作区的 ID(例如 wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ)。请参阅选择工作区。使用多工作区 API 密钥时必需。对于其他 API 密钥为可选。为单个工作区创建的密钥在您省略该标头时会在该工作区中运行。不适用于 Workload Identity Federation 令牌,这类令牌在令牌交换时选择工作区。
anthropic-versionAPI 版本(例如 2023-06-01)是
content-typeapplication/json是

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

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

获取 API 密钥

该 API 通过 Web Console 提供。您可以使用 playground 在浏览器中试用 API,然后在账户设置中生成 API 密钥(请参阅获取您的 Claude API 密钥)。创建密钥时,您可以选择每个密钥的类型(请参阅密钥类型)及其过期时间。使用工作区来分隔环境并按用例控制支出。

客户端 SDK

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

优势:

  • 自动标头管理(身份验证、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。有关功能可用性和时间安排,请参阅每个平台的页面。
  • 最适合: 现有云承诺、特定合规要求、合并云计费
平台提供商文档
Agent PlatformGoogle CloudGoogle Cloud 上的 Claude
Amazon BedrockAWSAmazon Bedrock 中的 Claude
Claude Platform on AWSAWS(Anthropic 运营)Claude Platform on AWS
Microsoft FoundryMicrosoft Azure(Anthropic 运营)Microsoft Foundry 中的 Claude

请求和响应格式

请求大小限制

端点最大请求大小
Messages、Token Counting32 MB
Message Batches API256 MB
Files API500 MB
Sessions、Agents、Environments32 MB

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

响应标头