GET /protocol 处提供自己的端点参考,涵盖该网关的登录、推理、托管设置、模型发现和遥测端点。这是一份与本指南分开的文档。
- 要为您的组织推出现有或第三方网关,请参阅推出 LLM 网关
- 如果您是使用给定的凭证向网关验证 Claude Code 的个人开发者,请参阅将 Claude Code 连接到 LLM 网关
- API 格式和每种格式要提供的端点
- 按连接方法的客户端行为:模型 ID、
anthropic-beta值、请求字段和默认值在格式和 Claude apps 网关登录之间的差异 - 请求标头:哪些必须到达上游,哪些您的网关可以使用
- 响应标头:返回什么以使停滞检测、重试和使用限制显示工作
- 系统提示属性块及其与提示缓存的交互方式
- 功能传递:删除标头或正文字段时会破坏什么
- 模型发现
- 转发不变:逐字节将其传递到上游
- 使用:网关可能会读取它以进行路由、属性或跟踪,不需要转发它
API 格式
网关必须向 Claude Code 客户端公开以下至少一种 API 格式。客户端选择一种格式,并通过下表”选择方式”列中的变量将 Claude Code 指向您的网关。 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_URL 和 ANTHROPIC_AWS_BASE_URL 路由到它们,但网关在任一前面实现上述 Anthropic Messages 行。在 AWS 上的 Claude Platform 前面的网关还必须转发 anthropic-workspace-id 头,该平台在每个请求上都需要。
可选端点和启动流量
令牌计数端点是唯一可选的:当它们不存在时,Claude Code 会回退到基于字符的上下文使用估计。 根据路径而不是完整 URL 进行匹配:- 推理请求发送到
/v1/messages?beta=true - Google Cloud 的 Agent Platform 方法后缀附加到发布者模型路径,如
/projects/{project}/locations/{location}/publishers/anthropic/models/{model}:streamRawPredict
HEAD /api/hello 连接预热探针,当配置了 HTTP 代理或客户端证书时,Claude Code 会跳过该探针。Amazon Bedrock 格式的网关接收 GET /inference-profiles?type=SYSTEM_DEFINED 请求,以及当配置的模型是推理配置文件时,GET /inference-profiles/{profile} 查询。
快速模式可用性检查永远不会出现在网关日志中:它直接调用 api.anthropic.com 而不是遵循 ANTHROPIC_BASE_URL,因此在阻止直接出站到 api.anthropic.com 的网络上,快速模式可能会报告连接错误,而通过网关的推理继续工作。WebFetch 域安全检查也直接调用 api.anthropic.com。在代理和 LLM 网关后面使用快速模式涵盖了恢复它的变量。
流式传输
流式传输推理响应。Claude Code 在流到达时读取流,因此如果您的网关在中继之前缓冲完整响应,Claude Code 会停滞。 当客户端使用 Amazon Bedrock 格式时,原样中继InvokeModelWithResponseStream 响应体及其 Content-Type: application/vnd.amazon.eventstream 头,不要将流转换为服务器发送事件。请参阅网关或代理后面的流式传输错误。
也转发保活 ping。在通过 ANTHROPIC_BASE_URL 或 ANTHROPIC_AWS_BASE_URL 的连接上,Claude Code 计算网关中继的每个字节,包括 SSE ping 事件和注释行,并默认在 300 秒内中止无声流。上游的 ping 是长思考暂停期间的唯一流量,因此如果您的网关剥离或缓冲它们,Claude Code 会在这些暂停期间中止流;自动重试涵盖了根据响应进度如何报告中止的流。完全不发送 ping 的上游(如 Amazon Bedrock 的二进制事件流)在这些暂停中没有任何东西可转发。从这样的上游转换时,在无声间隙期间发出您自己的 ping 事件。通过 ANTHROPIC_BEDROCK_BASE_URL、ANTHROPIC_VERTEX_BASE_URL 或 ANTHROPIC_FOUNDRY_BASE_URL 到达的网关不受此字节级监视程序的包装,即使它们中继 Anthropic Messages 格式;在那里,5 分钟空闲超时会中止无声流,在 ANTHROPIC_BEDROCK_BASE_URL 连接上,您可以使用 CLAUDE_ENABLE_BYTE_WATCHDOG_BEDROCK 添加字节监视程序。
与上游的格式不匹配
客户端使用的格式决定了您的网关接收的内容。常见的失败模式是客户端发送到您的网关的格式与其后面的上游提供商接受的格式不匹配。- 当客户端使用 Amazon Bedrock 或 Google Cloud 的 Agent Platform 格式时,Claude Code 仅发送这些提供商接受的完整功能集的子集
- 当客户端使用 Anthropic Messages 格式时,Claude Code 发送完整集,即使您的网关转发到 Amazon Bedrock 或 Google Cloud 的 Agent Platform 上游
连接方法如何改变客户端行为
开发者连接到网关的方式决定了 Claude Code 发送的模型 ID、anthropic-beta 值和请求字段,以及它应用的默认值。您的网关会看到以下三种客户端行为之一:
- Amazon Bedrock 或 Agent Platform 格式:开发者设置
CLAUDE_CODE_USE_BEDROCK=1和ANTHROPIC_BEDROCK_BASE_URL,或CLAUDE_CODE_USE_VERTEX=1和ANTHROPIC_VERTEX_BASE_URL,指向您的网关。Claude Code 使用该提供商的模型 ID、请求字段和默认值。 - Anthropic Messages 格式:开发者将
ANTHROPIC_BASE_URL设置为您的网关。Claude Code 将网关视为 Claude API,无法判断您转发到哪个上游。 - Claude apps gateway 登录:开发者登录到 Claude apps gateway。该网关使用 Anthropic Messages 格式,但可以路由到任何上游,因此 Claude Code 仅发送 Amazon Bedrock 和 Agent Platform 也接受的
anthropic-beta值和模型能力假设。
按连接方法的请求和默认值
下表比较了三种连接方法,每行一个行为。它省略了 Microsoft Foundry 和 Claude Platform on AWS,它们也使用 Anthropic Messages 格式,但 Claude Code 通过它们自己的变量访问。有关这些,请参阅 Microsoft Foundry 和 Claude Platform on AWS 页面。
有关每个连接支持的功能以及它默认发送给 Anthropic 的遥测,请参阅 功能可用性 和 按 API 提供商的默认行为。
未识别模型 ID 的设置
两个客户端设置改变了 Claude Code 对它无法识别的模型 ID 的假设,无论开发者使用哪种连接方法:- 上下文窗口:Claude Code 假设 200K,或当 ID 包含
[1m]时为 1M。要声明真实窗口,请参阅 为网关或自定义模型 ID 更正窗口 - 能力:要给网关别名赋予其后面模型的能力,请使用您分发的设置中的
modelOverrides条目将该模型的 Anthropic ID 映射到您的别名。有关ANTHROPIC_DEFAULT_*_MODEL_SUPPORTED_CAPABILITIES变量适用的位置,请参阅 功能传递
请求头
Claude Code 在 API 请求上包含这些请求头。请求头名称在网络上不区分大小写。转发anthropic-version 和 anthropic-beta 不变,加上当上游是 AWS 上的 Claude Platform 时的 anthropic-workspace-id;其余的 gateway 可能会使用它们进行路由、归属和跟踪,不需要转发。
子代理 ID 在每次生成时都会生成新的。队友代理,代理团队的命名成员,在重新连接时重用基于名称的稳定 ID。在两种情况下,ID 都标识一个代理,而不是一个人或设备,因此不要将代理 ID 请求头视为用户标识符。
如果您的开发者设置了
ANTHROPIC_CUSTOM_HEADERS,这些请求头也会出现在请求上。
Gateway 提示请求头
Claude Code 还可以发送路由提示:gateway 或路由器可以用来调度、缓存或归属请求的每个请求事实。需要 Claude Code v2.1.273 或更高版本。 请求是否携带它们取决于 Claude Code 将其发送到何处:- 直接连接到 Anthropic API:默认发送
- 自定义基础 URL:默认关闭,因为拒绝未知请求头的代理会导致请求失败。要接收它们,请为您的开发者设置
CLAUDE_CODE_GATEWAY_HINT_HEADERS=1,例如在托管设置的env块中 - 任何其他后端,包括 Amazon Bedrock、Google Cloud 的 Agent Platform、Microsoft Foundry 和 AWS 上的 Claude Platform:仅当设置
CLAUDE_CODE_GATEWAY_HINT_HEADERS=1时发送
CLAUDE_CODE_GATEWAY_HINT_HEADERS 设置为 0 会在每个连接上停止这些请求头。
这些请求头仅携带下面行列出的内容:固定词汇、工具名称和持续时间,从不包含提示文本或文件内容。每个值都是可打印的 ASCII。
在解析
x-claude-code-prev-tool-durations 之前,检查 Claude Code 如何构建该值以及它遗漏了什么:
- 条目:每个运行的工具调用一个,按其结果被收集的顺序,以整毫秒为单位
- 上限:Claude Code 最多发送 32 个条目和 4 KB,保留第一个条目
- 编码:工具名称是百分比编码的,涵盖
%、;、=、逗号、空格和任何可打印 ASCII 之外的字符 - 解析:在
;上分割,然后在=上分割,并解码每个名称 - 缺失:压缩调用、辅助请求和新提示的第一个请求不携带它。不要将缺失的请求头读作运行无工具的回合
- 时间:每个时间都排除权限提示和 hooks,并行工具调用各自报告自己的时间,因此条目不会加起来等于请求之间的间隔
作为开放列表转发
将请求头和请求体字段视为开放列表,而不是封闭列表。Claude Code 在版本中获得功能,它们作为新的anthropic-beta 值、新的请求体字段以及偶尔新的 anthropic-* 或 x-claude-code-* 请求头到达。
转发到 Anthropic 格式上游时,将 anthropic-* 请求头和请求体字段原封不动地传递,而不是将您今天看到的列入白名单。固定到观察列表的 gateway 会删除下一个功能的请求头或字段,并在引入它的版本上破坏它。
例外是非 Anthropic 上游,如 Amazon Bedrock 或 Google Cloud 的 Agent Platform,其中弥合架构差异是 gateway 的工作;请参阅功能传递。
响应头
Claude Code 读取这些响应头来检测停滞的流、决定是否以及何时重试,以及显示使用限制。该表列出了每个响应头应返回的内容。同时转发错误响应体不做修改,以便 Claude Code 的能力拒绝恢复可以匹配上游的错误措辞。系统提示归属块
Claude Code 在系统提示前面加上一个短的归属块,其中包含客户端版本和从对话派生的指纹。api.anthropic.com 端点在处理前删除该块,因此它不会影响第一方提示缓存。任何其他上游都会将其作为提示的一部分接收。
该删除是位置相关的,因此只有在网关原样转发 system 数组时才有效。要在不丢失其他系统内容的情况下将该块排除在提示之外:
- 完全按照接收的方式转发
system数组,保持该块在最前面:在前面加上另一个系统块、重新排序数组或将其转换为单个字符串会破坏删除,该块随后会到达模型和提示缓存键。 - 将该块保留在其自己的数组条目中:端点将以归属标头开头的合并块视为完整的归属,并删除合并到其中的所有内容,包括系统提示的其余部分。
- 如果您的网关必须重新整形系统内容,请设置
CLAUDE_CODE_ATTRIBUTION_HEADER=0以便 Claude Code 省略该块。Anthropic 和云提供商的 Claude 端点读取该块以进行归属,因此要在客户端省略它,而不是在网关中删除或移动它。
0 时也会在 auto mode 分类器请求上保留该块:
- 请求发送到
api.anthropic.com,ANTHROPIC_BASE_URL未设置或命名该主机,且未选择第三方提供商。 - 活跃凭证不是 Anthropic 配置文件或联合凭证。
0 也会从分类器请求中删除该块。在 v2.1.229 之前,此例外不存在:设置 0 会从这些分类器请求中删除该块,当 API 拒绝未识别的请求时,auto mode 在它发送给分类器的每个操作上都会失败。
从 Claude Code v2.1.181 开始,当请求通过自定义基础 URL 路由时,该块在对话的生命周期内是稳定的,因此以完整请求体为键的网关端提示缓存可以在不禁用它的情况下工作,您的网关转发到的任何提供商都会接收稳定的提示前缀。在 v2.1.181 之前,该块包含每个请求的令牌,在系统提示的开始处改变了每个请求。在这些版本上,当您的网关执行以下任一操作时,请设置 CLAUDE_CODE_ATTRIBUTION_HEADER=0:
- 实现以请求体为键的提示缓存。
- 将请求转发到第三方提供商,例如 Amazon Bedrock、Microsoft Foundry 或 Google Cloud 的 Agent Platform,采用 Anthropic Messages 格式或提供商自己的格式,其中变化的前缀会减少该提供商上的提示缓存重用。
功能传递
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_BEDROCK、CLAUDE_CODE_USE_VERTEX、CLAUDE_CODE_USE_FOUNDRY 和 CLAUDE_CODE_USE_MANTLE。它们在 ANTHROPIC_BASE_URL gateway 后面没有效果。
自动重试和错误转发
Claude Code 在上游拒绝后的操作取决于被拒绝的内容:- 当上游拒绝
thinking字段、中途对话系统消息或这些消息之一上的cache_control标记时,Claude Code 会重试请求并为对话的其余部分禁用被拒绝的功能 - 当上游拒绝思考签名时,包括带有
400的拒绝,其消息说该块被bound to a different conversation,Claude Code 会从请求中删除早期思考块,重试,并将其排除在每个后续请求之外。新响应仍然包括思考 - 当 gateway 或其上游将顾问工具条目在
tools中拒绝为无法识别的工具类型时,Claude Code 会重试一次请求,不包含该条目及其anthropic-beta值。对该基础 URL 的后续请求会将顾问排除在外,直到 Claude Code 退出,在该时间内/advisor对开发者不可用。Claude Code 通过400或422响应识别此拒绝,其消息在Input tag之后命名工具类型,例如Input tag 'advisor_20260301'。在 v2.1.280 之前,Claude Code 没有重试此拒绝 - Claude Code 不重试上下文管理或工具架构字段拒绝,因此这些
400错误到达开发者
bound to a different conversation 拒绝来自 API 的保留思考检查,当 system、tools 或早期 messages 内容与产生思考的请求不同时,该检查失败。重写任何该内容的 gateway 可能会导致拒绝本身;库、代理和网关涵盖了要原封不动地传递的内容。
重试逻辑与上游的错误措辞匹配,因此原封不动地转发错误响应体。将上游错误包装在自己的信封中的 gateway 会破坏恢复路径,即使它保留了状态代码,除非信封的消息携带稳定的 capability_rejected: 令牌。Claude apps gateway 为云提供商的错误措辞替换这些令牌,例如 capability_rejected: prompt_too_long。
禁用预发布功能
CLAUDE_CODE_DISABLE_EXPERIMENTAL_BETAS=1 阻止 Claude Code 在每个提供商上发送预发布功能及其请求体字段,包括上下文管理和 beta 工具字段。该变量不影响自适应推理,后者由模型而不是 beta 选择。它永远不会抑制订阅身份验证所需的 OAuth 功能。
在 Claude Code v2.1.227 或更高版本上,您的组织可以通过托管设置在此变量下保持 MCP 工具搜索打开。Claude Code 在该覆盖生效时发送的内容取决于您如何连接:
- 在直接连接上,或通过设置了
ANTHROPIC_BASE_URL的 gateway,Claude Code 继续发送工具搜索 beta 请求头、defer_loading工具字段和tool_reference块,并删除其余部分 - 在云提供商上,或通过 Claude apps gateway 登录,覆盖没有效果
模型发现
当ANTHROPIC_BASE_URL 指向公开 Anthropic Messages 格式的 gateway 时,Claude Code 可以在启动时查询 gateway 的 /v1/models 端点,并将返回的模型添加到 /model 选择器。如果您或您的管理员在 modelPicker 配置中设置了 replaceBuiltInOptions,Claude Code 会从选择器中隐藏发现的模型。
开发者通过在自己的环境中或通过托管设置设置 CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY=1 来启用它。发现默认关闭,以便由共享 API 密钥支持的 gateway 不会向每个用户公开密钥可以访问的每个模型。
发现何时运行
发现仅适用于 Anthropic Messages 格式。在以下情况下不运行:- 设置了任何
CLAUDE_CODE_USE_*提供商变量,即使也设置了ANTHROPIC_BASE_URL ANTHROPIC_BASE_URL未设置或指向api.anthropic.com
请求和响应
请求是GET /v1/models?limit=1000,超时为 3 秒,任何重定向都被视为失败,因此凭证不会泄露到重定向目标。响应缓慢或重定向 /v1/models 的 gateway,即使是 http 到 https,也会无声地失败发现;在配置的基础 URL 处直接提供端点。
要给缓慢的 gateway 更长的时间,请设置 CLAUDE_CODE_GATEWAY_MODEL_DISCOVERY_TIMEOUT_MS。该变量需要 Claude Code v2.1.269 或更高版本。
Claude Code 使用下面两个凭证请求头发送发现请求,并省略其值无法解析的请求头。发送两个请求头需要 Claude Code v2.1.248 或更高版本。早期版本在设置了 ANTHROPIC_AUTH_TOKEN 时仅发送 Authorization,否则仅发送 x-api-key。
Authorization:ANTHROPIC_AUTH_TOKEN作为承载令牌,否则apiKeyHelper值作为承载令牌。在这种情况下,Claude Code 在发送请求前等待助手返回。x-api-key:Claude Code 解析的 API 密钥,例如ANTHROPIC_API_KEY。当助手值是唯一的凭证时,此请求头也会携带它,因此该值会在两个请求头中到达。
ANTHROPIC_CUSTOM_HEADERS 的任何请求头。当自定义请求头具有非空值时,Claude Code 会发送它来代替同名的内置请求头,不区分大小写地匹配名称。
当两个凭证请求头的值都无法解析时,Claude Code 会跳过发现,并在 claude --debug 会话的调试日志中写入 [gatewayDiscovery] skipped 行。如果您仅通过 ANTHROPIC_CUSTOM_HEADERS 提供凭证,Claude Code 仍然会跳过发现。
Claude Code 从响应的 data 数组中的每个条目读取 id、可选的 display_name 和可选的 description:
id 中任何位置包含 claude 或 anthropic 的条目会被保留,不区分大小写,其余的会被忽略。提供商前缀的 ID,例如 vertex_ai/claude-sonnet-4-6 或 bedrock/anthropic.claude-sonnet-4-5 会通过过滤器;不包含任何一个子字符串的 ID 则不会。在 v2.1.223 之前,Claude Code 仅在其 id 以 claude 或 anthropic 开头时保留条目,这隐藏了提供商前缀的 ID。
选择器条目和缓存
选择器是当开发者在 Claude Code 中运行/model 时打开的交互式模型列表。每个发现的条目在 gateway 发送与 id 不同的 display_name 时使用 display_name 作为其名称。否则,当 Claude Code 识别 id 时,条目显示模型的名称,当不识别时显示 id。例如,具有 id my-gateway-claude-sonnet-4-6 且没有 display_name 的条目显示为 Sonnet 4.6。
发现仅添加 availableModels 托管设置 允许的模型。
每个条目还显示模型的 description,折叠为一行。没有 description 的条目改为显示”From gateway”。在 v2.1.257 之前,每个发现的条目都显示”From gateway”。
当发现的 ID 与选择器中已有的行匹配时,它不会获得自己的行:
- 相同 ID:发现的 ID 完全匹配现有行的 ID,或两个 ID 是同一 Fable 版本的拼写。
- 与内置别名相同的模型:当发现的显式 ID 命名内置别名当前解析到的模型时,选择器仅显示别名行。例如,当
sonnet解析为claude-sonnet-5时,发现的claude-sonnet-5会折叠到sonnet行中,而发现的claude-sonnet-4-6仍会获得自己的行。在 v2.1.197 之前,Claude Code 不会将这些 ID 折叠到内置行中,因此claude-sonnet-5也会获得自己的”From gateway”行。
~/.claude/cache/gateway-models.json,或在 Windows 上 %USERPROFILE%\.claude\cache\gateway-models.json,并在每次启动时刷新。如果您设置了 CLAUDE_CONFIG_DIR,缓存会改为位于该目录下。如果请求失败或 gateway 未实现 /v1/models,选择器会回退到上次启动的缓存列表或内置模型列表。如果您的 gateway 在不匹配发现过滤器的别名下提供 Claude 模型,开发者可以使用模型配置变量手动添加这些别名。
相关资源
有关 gateway 文档集的其余部分和基础 API 参考:- Gateway 概述:什么是 gateway 以及如何在 Claude 应用 gateway 和其他产品之间进行选择
- 其他 LLM gateway:如何推出您的组织运行的 gateway 以及它如何与 claude.ai 订阅交互
- 为您的组织推出 LLM gateway:使用此指南的管理员检查清单
- 将 Claude Code 连接到 LLM gateway:每个开发者的配置和故障排除表
- Beta 请求头参考:当前的
anthropic-beta值集 - Messages API:Anthropic 格式 gateway 实现的 API 格式