跳转到主要内容
本页面记录了 Claude Code 发送到 gateway 的请求,包括它调用的端点、gateway 必须转发的请求头和请求体字段,以及当 gateway 不转发这些内容时哪些功能会停止工作。本页面是为配置 gateway 产品以与 Claude Code 配合工作的运营人员编写的。 一个运行中的 Claude apps gatewayGET /protocol 处提供此契约的机器可读版本,涵盖相同的转发要求以及 Claude apps gateway 特定的 SSO 登录、托管设置交付和遥测端点。Claude apps gateway 从与 CLI 相同的 claude 二进制文件运行,因此 Claude apps gateway 快速入门 是获取可以从中获取规范的运行实例的最短路径。
本页面涵盖: 本页面对您的 gateway 处理每个请求头和请求体字段的方式使用两个术语:
  • 转发不变:将其逐字节传递到上游
  • 使用:gateway 可能会读取它用于路由、归属或跟踪,不需要转发它
任何未标记为转发不变的内容都可以由您使用或忽略。

API 格式

gateway 必须向 Claude Code 客户端公开以下至少一种 API 格式。Claude Code 使用哪种格式由客户端的配置决定:下表”选择者”列中的变量指向您的 gateway 使用该格式。Google Cloud 的 Agent Platform 是 Google Cloud 的 Claude 端点,原名 Vertex AI;其变量名保留 VERTEX 拼写。

Foundry 和 AWS 上的 Claude Platform

Microsoft Foundry 和 AWS 上的 Claude Platform 实现了 Anthropic Messages 格式。Claude Code 通过它们自己的变量 ANTHROPIC_FOUNDRY_BASE_URLANTHROPIC_AWS_BASE_URL 路由到它们,但 fronting 任一方的 gateway 实现上面的 Anthropic Messages 行。fronting AWS 上的 Claude Platform 的 gateway 还必须转发 anthropic-workspace-id 请求头,该平台在每个请求上都需要

可选端点和启动流量

令牌计数端点是唯一可选的:当它们不存在时,Claude Code 在本地估计上下文使用情况。推理请求发送到 /v1/messages?beta=true,因此请匹配路径,而不是完整 URL。Google Cloud 的 Agent Platform 方法后缀附加到发布者模型路径,如 /projects/{project}/locations/{location}/publishers/anthropic/models/{model}:streamRawPredict gateway 还会看到尽力而为的启动流量,它可以拒绝而不会破坏任何东西:一个 HEAD / 连接探针,以及在 Amazon Bedrock 格式 gateway 上的 GET /inference-profiles?type=SYSTEM_DEFINED 请求。

流式传输

推理响应必须流式传输。Claude Code 在服务器发送事件到达时使用它们,因此缓冲完整响应然后中继它们的 gateway 会使客户端停滞。

与上游的格式不匹配

客户端使用的格式决定了您的 gateway 接收的内容。常见的失败模式是客户端发送到您的 gateway 的格式与上游提供商接受的格式之间的不匹配。
  • 当客户端使用 Amazon Bedrock 或 Google Cloud 的 Agent Platform 格式时,Claude Code 仅发送这些提供商接受的完整功能集的子集
  • 当客户端使用 Anthropic Messages 格式时,Claude Code 发送完整集合,即使您的 gateway 转发到 Amazon Bedrock 或 Google Cloud 的 Agent Platform 上游
弥合这种差异是您的 gateway 的工作。功能传递描述了当它不这样做时会破坏什么。

请求头

Claude Code 在 API 请求上包含这些请求头。请求头名称在网络上不区分大小写。转发 anthropic-versionanthropic-beta 不变,加上当上游是 AWS 上的 Claude Platform 时的 anthropic-workspace-id;其余的 gateway 可能会使用它们进行路由、归属和跟踪,不需要转发。 子代理 ID 在每次生成时都会生成新的。队友代理,代理团队的命名成员,在重新连接时重用基于名称的稳定 ID。在两种情况下,ID 都标识一个代理,而不是一个人或设备,因此不要将代理 ID 请求头视为用户标识符。 如果您的开发者设置了 ANTHROPIC_CUSTOM_HEADERS,这些请求头也会出现在请求上。

作为开放列表转发

将请求头和请求体字段视为开放列表,而不是封闭列表。Claude Code 在版本中获得功能,它们作为新的 anthropic-beta 值、新的请求体字段以及偶尔新的 anthropic-*x-claude-code-* 请求头到达。 转发到 Anthropic 格式上游时,将 anthropic-* 请求头和请求体字段原封不动地传递,而不是将您今天看到的列入白名单。固定到观察列表的 gateway 会删除下一个功能的请求头或字段,并在引入它的版本上破坏它。 例外是非 Anthropic 上游,如 Amazon Bedrock 或 Google Cloud 的 Agent Platform,其中弥合架构差异是 gateway 的工作;请参阅功能传递

系统提示归属块

Claude Code 在系统提示前面加上一个短的归属块,其中包含客户端版本和从对话派生的指纹。api.anthropic.com 端点在处理前删除该块,因此它不会影响第一方提示缓存。任何其他上游都会将其作为提示的一部分接收。 该删除是位置相关的,因此只有在网关原样转发 system 数组时才有效。要在不丢失其他系统内容的情况下将该块排除在提示之外:
  • 完全按照接收的方式转发 system 数组,保持该块在最前面:在前面加上另一个系统块、重新排序数组或将其转换为单个字符串会破坏删除,该块随后会到达模型和提示缓存键。
  • 将该块保留在其自己的数组条目中:端点将以归属标头开头的合并块视为完整的归属,并删除合并到其中的所有内容,包括系统提示的其余部分。
  • 如果您的网关必须重新整形系统内容,请设置 CLAUDE_CODE_ATTRIBUTION_HEADER=0 以便 Claude Code 省略该块。Anthropic 和云提供商的 Claude 端点读取该块以进行归属,因此要在客户端省略它,而不是在网关中删除或移动它。
未修改到达端点的请求不受影响。 从 Claude Code v2.1.181 开始,当请求通过自定义基础 URL 路由时,该块在对话的生命周期内是稳定的,因此以完整请求体为键的 gateway 端提示缓存可以在不禁用它的情况下工作。在 v2.1.181 之前,该块包含每个请求的令牌;在这些版本上,如果您的 gateway 实现了这样的缓存,请设置 CLAUDE_CODE_ATTRIBUTION_HEADER=0

功能传递

Claude Code 将 ANTHROPIC_BASE_URL gateway 视为 Anthropic 格式端点,并向其发送它发送到 api.anthropic.com 的 beta 请求头和请求体字段,除了为直接连接保留的一小组诊断和默认值,例如下面涵盖的细粒度工具流式传输默认值。该集合因版本而异,因此不要依赖其内容。 添加请求体字段的功能将它们与 beta 请求头配对,该对一起传递。删除请求头同时传递请求体的 gateway,或将 Anthropic 格式请求体转发到具有不同架构的上游,会产生硬 400 错误;只有当两个部分一起缺失时,功能才会安静地关闭。重写或编辑请求体以进行内容检查的 gateway 会以与删除相同的方式破坏配对,因此在不修改的情况下检查。该表注明了功能偏离配对的位置。 细粒度工具流式传输是直接连接默认值之一:每当请求通过自定义基础 URL 路由时,它默认关闭,当开发者设置 CLAUDE_CODE_ENABLE_FINE_GRAINED_TOOL_STREAMING=1 时,gateway 会接收它。 ANTHROPIC_DEFAULT_*_MODEL_SUPPORTED_CAPABILITIES 变量仅在提供商配置中声明模型功能:CLAUDE_CODE_USE_BEDROCKCLAUDE_CODE_USE_VERTEXCLAUDE_CODE_USE_FOUNDRYCLAUDE_CODE_USE_MANTLE。它们在 ANTHROPIC_BASE_URL gateway 后面没有效果。

自动重试和错误转发

Claude Code 在某些上游拒绝后自动重试,并为对话的其余部分禁用被拒绝的功能。thinking 字段的拒绝、思考签名的拒绝和中途对话系统消息的拒绝都以这种方式恢复。上下文管理和工具架构字段拒绝不重试;这些 400 错误到达开发者。 重试逻辑与上游的错误措辞匹配,因此原封不动地转发错误响应体。将上游错误包装在自己的信封中的 gateway 会破坏恢复路径,即使它保留了状态代码。

禁用预发布功能

CLAUDE_CODE_DISABLE_EXPERIMENTAL_BETAS=1 阻止 Claude Code 在每个提供商上发送预发布功能及其请求体字段,包括上下文管理和 beta 工具字段。它不影响自适应推理,后者由模型而不是 beta 选择,它永远不会抑制订阅身份验证所需的 OAuth 功能。 Claude Code 发送的功能集随版本增长。有关当前 beta 请求头字符串,请参阅 beta 请求头参考;针对新的 Claude Code 版本测试您的 gateway,而不是固定到观察列表。

模型发现

ANTHROPIC_BASE_URL 指向公开 Anthropic Messages 格式的 gateway 时,Claude Code 可以在启动时查询 gateway 的 /v1/models 端点,并将返回的模型添加到 /model 选择器。 开发者通过在自己的环境中或通过托管设置设置 CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY=1 来启用它。发现默认关闭,以便由共享 API 密钥支持的 gateway 不会向每个用户公开密钥可以访问的每个模型。这需要 Claude Code v2.1.129 或更高版本。

发现何时运行

发现仅适用于 Anthropic Messages 格式。在以下情况下不运行:
  • 设置了任何 CLAUDE_CODE_USE_* 提供商变量,即使也设置了 ANTHROPIC_BASE_URL
  • ANTHROPIC_BASE_URL 未设置或指向 api.anthropic.com
  • 非必要流量被禁用,通过 CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC 或组织策略

请求和响应

请求是 GET /v1/models?limit=1000,超时为 3 秒,任何重定向都被视为失败,因此凭证不会泄露到重定向目标。响应缓慢或重定向 /v1/models 的 gateway,即使是 httphttps,也会无声地失败发现;在配置的基础 URL 处直接提供端点。 发现请求恰好发送一个凭证请求头:
  • 设置时 ANTHROPIC_AUTH_TOKEN 作为承载令牌
  • 否则解析的 API 密钥,包括 apiKeyHelper 值,在 x-api-key 请求头中
这与推理请求不同,后者在两个请求头中发送帮助程序值。验证 /v1/models 的 gateway 必须为帮助程序部署接受 x-api-key。来自 ANTHROPIC_CUSTOM_HEADERS 的任何请求头也包括在内。 Claude Code 从响应的 data 数组中的每个条目读取 id 和可选的 display_name,并忽略其 id 不以 claudeanthropic 开头的条目:

选择器条目和缓存

选择器是当开发者在 Claude Code 中运行 /model 时打开的交互式模型列表。每个发现的条目都标记为”来自 gateway”,并在提供时使用 display_nameavailableModels 托管设置限制了发现可以添加的内容。 仅当发现的 ID 与选择器中已有的行完全匹配时,或当发现的和现有的 ID 都解析为 Fable 时,才会跳过发现的 ID。从 Claude Code v2.1.197 开始,当发现的显式 ID 和内置条目都解析为同一模型时,发现的显式 ID 也会折叠到内置条目中。内置行按别名(如 sonnet)键入,因此发现的显式 ID(如别名当前解析到的模型 claude-sonnet-5)会折叠到 sonnet 行中,而别名不解析到的 ID(如 claude-sonnet-4-6)仍会在内置条目旁边添加自己的”来自 gateway”行。 结果被缓存到 ~/.claude/cache/gateway-models.json,或在 Windows 上 %USERPROFILE%\.claude\cache\gateway-models.json,并在每次启动时刷新。如果请求失败或 gateway 未实现 /v1/models,选择器会回退到上次启动的缓存列表或内置模型列表。如果您的 gateway 在不匹配发现过滤器的别名下提供 Claude 模型,开发者可以使用模型配置变量手动添加这些别名。 有关 gateway 文档集的其余部分和基础 API 参考: