个人工作台

Teapot Router / 入门教程

把 Teapot Router 接入你正在使用的客户端

不用安装额外的配置工具。跟着下面的步骤准备 Key、填写地址、发出第一条请求;每一步都能回到工作台核对。

打开工作台
01 / 开始之前

先准备好这三项

一把真实 API Key

在工作台的「API 令牌」创建 Key,再到「配置客户端」点击这把 Key 的「显示」。演示页生成的 Key 不能发起真实调用。

正确的接口地址

以「配置客户端」弹窗显示的地址为准。Claude Code 使用不带 /v1 的网关根地址;OpenAI 兼容客户端使用末尾带 /v1 的 Base URL。不要把官网地址当作 API 地址。

可用模型和余额

登录后可在下方复制当前账户可用的模型 ID,并确认账户有余额。若列表为空,请管理员启用渠道。价格目录仅供参考,不代表上游一定可调用。

你当前账户的 API 地址

从 Teapot Router 的网关接入配置读取。按客户端复制对应地址;API Key 仍需在工作台登录后显示。

请登录已连接网关的真实工作台,才能看到你的实际 API 地址。不要照抄示例地址。

API Key 相当于密码。不要把它贴进聊天、截图、文档或公开仓库;配置时只粘贴到可信客户端。

02 / Codex CLI

Codex CLI:完成第一次调用

用一个新开的终端窗口,按你的系统生成 Codex CLI 命令,通过 Teapot Router 发出第一次请求。开始前需有支持 Responses 的真实渠道、模型和账户余额。

会影响我现在正在用的 Codex 吗?

不要把下面的整段命令粘到 Codex Settings。它是在新终端执行的一次性命令,只让新启动的 Codex CLI 走 Teapot Router;不会改 ~/.codex/config.toml、替换原有登录,也不会切换你现在这段 Codex 对话。正式使用也可以按会话选择服务;只有主动修改全局默认,普通启动 Codex 才会默认走 Teapot Router。

  1. 用真实 Teapot Router 账户登录工作台,准备一把可用的 API Key。演示账户和演示 Key 无法调模型。
  2. 让管理员给测试账户少量额度:可以发一张有效兑换码,你在「兑换码」页面兑换;也可以由管理员直接给账户增加测试额度。回「充值」确认余额已经增加。兑换码功能须由管理员先启用。
  3. 让管理员确认至少有一条支持 Responses 的真实上游渠道和可用模型。只有余额、没有渠道仍无法调用。
  4. 在下方选择运行系统、已有 Key 和模型 ID,再选择「长期使用」或「仅测试一次」。点击「复制可直接运行的命令」,另开对应的 bash/zsh 或 Windows PowerShell 终端运行,别粘到 Codex Settings。预览会隐藏 Key;复制的命令包含真实 Key。
  5. 新开的 Codex CLI 启动后,输入「请只回复 OK」。收到回复,再回 Teapot Router「用量记录」核对请求。测试完退出这段 CLI;你原来的 Codex 会话可以继续使用。

生成你的 Codex 测试命令

选择一把已有 Key 和一个模型,直接生成这次测试使用的命令。

系统只决定命令格式;如果你要把命令复制到另一台电脑,可以手动切换。

安装独立的 Teapot Router 配置。以后运行专用命令即可使用;原来的 Codex 默认配置不变。

正在读取…

备用:手动输入地址、模型和 Key
(
  printf 'OpenAI Base URL (ends in /v1): '
  IFS= read -r RELAY_BASE
  printf 'Responses model ID: '
  IFS= read -r RELAY_MODEL
  printf 'Teapot Router API Key: '
  IFS= read -r -s RELAY_KEY_FOR_CODEX
  printf '\n'
  export RELAY_KEY_FOR_CODEX
  codex -m "$RELAY_MODEL" \
    -c 'model_provider="relay"' \
    -c "model_providers.relay={name=\"Teapot Router\",base_url=\"$RELAY_BASE\",env_key=\"RELAY_KEY_FOR_CODEX\",wire_api=\"responses\",requires_openai_auth=false}"
)

「仅测试一次」只影响当前终端;「长期使用」会建立独立的 Teapot Router profile,不会修改原有 Codex 配置。Windows 使用当前用户的 DPAPI 加密保存 Key,macOS/Linux 使用系统钥匙串或独立配置。复制的完整命令可能留在剪贴板和终端历史,请在私有终端运行并于测试后清理。若报 401,先查 Key;若报模型或渠道不可用,先查 NEW-API 渠道。

先了解测试额度与充值
03 / Claude Code

Claude Code

适合希望在终端使用 Claude Code 的用户。下面先给出只在当前终端窗口生效的配置方法,关闭窗口后不会修改你原来的客户端设置。

  1. 如果还没安装 Claude Code,先按其官方安装说明安装并确认可以运行 claude 命令。
  2. 回到 Teapot Router 工作台 → 配置客户端 → Claude Code,复制不带 /v1 的地址,并显示你的 Key。再从本页「开始之前」章节复制一个 Claude 模型 ID。
  3. 打开终端。把下方 <TEAPOT_API_BASE_URL> 和 <CLAUDE_MODEL_ID> 换成你的实际值,执行命令;看到提示后再粘贴 Key 并按回车。输入 Key 时屏幕不显示字符,是正常的。
  4. 在 Claude Code 中发送一条简短消息,例如「请回复 OK」。成功返回后,到 Teapot Router 的「用量记录」核对这一条请求。

macOS / Linux(bash、zsh)

export ANTHROPIC_BASE_URL="<TEAPOT_API_BASE_URL>"
printf 'Teapot Router API Key: '
read -rs ANTHROPIC_AUTH_TOKEN
printf '
'
export ANTHROPIC_AUTH_TOKEN
export ANTHROPIC_MODEL="<CLAUDE_MODEL_ID>"
export ANTHROPIC_DEFAULT_SONNET_MODEL="$ANTHROPIC_MODEL"
export ANTHROPIC_DEFAULT_HAIKU_MODEL="$ANTHROPIC_MODEL"
export ANTHROPIC_DEFAULT_OPUS_MODEL="$ANTHROPIC_MODEL"
claude

Windows PowerShell

$env:ANTHROPIC_BASE_URL = "<TEAPOT_API_BASE_URL>"
$secret = Read-Host "Teapot Router API Key" -AsSecureString
$env:ANTHROPIC_AUTH_TOKEN = [System.Net.NetworkCredential]::new("", $secret).Password
$env:ANTHROPIC_MODEL = "<CLAUDE_MODEL_ID>"
$env:ANTHROPIC_DEFAULT_SONNET_MODEL = $env:ANTHROPIC_MODEL
$env:ANTHROPIC_DEFAULT_HAIKU_MODEL = $env:ANTHROPIC_MODEL
$env:ANTHROPIC_DEFAULT_OPUS_MODEL = $env:ANTHROPIC_MODEL
claude

这组命令仅对当前终端会话生效。需要长期保存时,请使用 Claude Code 官方支持的配置方式,并先备份已有配置;不要直接覆盖原有 settings.json。

04 / OpenAI 兼容客户端

OpenAI 兼容客户端

适合支持「自定义 OpenAI 接口」的聊天客户端或使用 OpenAI SDK 的应用。不同客户端的菜单名称略有差异,但要填写的三项相同。

  1. 在客户端的设置中找到 Provider、模型提供方或 API 设置,选择 OpenAI compatible、Custom OpenAI 或自定义接口。
  2. 将「Base URL」填为配置弹窗中 OpenAI 兼容标签下的地址,末尾应是 /v1;将「API Key」填为你刚显示的真实 Key。
  3. 在「Model / 模型」中填入本页「开始之前」章节可用列表里的完整模型 ID。保存后发送一条简短消息,并回 Teapot Router「用量记录」核对。
客户端字段应填内容
Base URL / API 地址Teapot Router 网关地址 + /v1;从「配置客户端」弹窗复制。
API Key你在 Teapot Router 创建并显示的真实 Key。
Model / 模型该 Key 有权限使用的完整模型 ID,大小写与符号保持一致。
开发者可选:用 Python 做最小验证

如果没有现成的图形客户端,可以安装 openai Python 包后运行下面的脚本。脚本会交互输入地址、Key 和模型,不会把 Key 写进源文件。

# First run: python3 -m pip install openai
from getpass import getpass
from openai import OpenAI

base_url = input("Teapot Router Base URL (ends in /v1): ").strip()
model = input("Model ID: ").strip()
client = OpenAI(base_url=base_url, api_key=getpass("Teapot Router API Key: "))
result = client.chat.completions.create(
    model=model,
    messages=[{"role": "user", "content": "Reply with OK."}],
)
print(result.choices[0].message.content)
05 / 确认接入成功

确认接入成功

「复制成功」或点击工作台的「已配置」只表示你完成了页面操作,不代表客户端已经发出请求。以一次真实调用为准。

  1. 客户端出现模型回复,而不是只显示“配置已保存”。
  2. 打开工作台的「用量记录」,能找到对应时间、模型和 Key 的请求。
  3. 回到概览点击「检查调用」。如果这是该账户首次请求,第三步会更新;仍未更新时刷新页面并核对登录账户。
确认接入成功
06 / 常见问题

常见问题

401 / Key 无效

确认使用的是当前账户的真实 Key,Key 仍启用、未过期;检查 API 地址有没有误填成官网地址。

找不到模型或没有可用渠道

模型 ID 必须与后台启用的模型一致,并且 Key 所属分组可用;请管理员核对上游渠道。单纯充值不能解决渠道缺失。

余额或 Key 额度不足

到「充值」查看账户余额;若 Key 设置了独立额度,还要查看 Key 的剩余额度。

客户端有回复,但页面还没显示完成

刷新「用量记录」和概览,核对用的是同一账户;概览的首次调用状态按账户请求记录更新。

仍然卡住?请告诉支持人员客户端名称、报错原文和发生时间。不要发送完整 API Key。