Espaço de trabalho

Teapot Router / GUIA INICIAL

Ligue o Teapot Router ao seu cliente

Não precisa de instalar outra ferramenta. Prepare uma chave, introduza o endereço correto, faça um pedido e confirme-o no painel.

Abrir painel
01 / Antes de começar

Prepare estes três elementos

Uma chave API real

Crie uma chave em « API keys ». Depois abra « Configurar cliente » e revele-a. As chaves de demonstração não permitem pedidos reais.

O endereço correto da API

Use o endereço mostrado na janela de configuração. Claude Code usa a raiz sem /v1; clientes compatíveis com OpenAI usam a Base URL terminada em /v1. O endereço do site não é o da API.

Modelo disponível e saldo

Obtenha o ID de um modelo ativo permitido para a sua chave e confirme o saldo. Ver um preço não garante que o canal esteja pronto.

Os seus endereços API atuais

Carregados do gateway ligado a esta conta Teapot Router. Copie o endereço para o seu cliente; a chave continua no painel.

Inicie sessão num painel ligado ao gateway para ver os endereços reais. Não use um endereço de exemplo.

Trate a chave API como uma palavra-passe. Não a partilhe em chats, imagens, documentos ou repositórios públicos; introduza-a apenas em clientes de confiança.

02 / Codex CLI

Codex CLI: primeira chamada

Teste o Teapot Router neste terminal sem alterar a configuração existente do Codex. Precisa de canal e modelo Responses ativos e saldo na conta.

Isto altera a minha sessão Codex atual?

Não. O comando encaminha apenas o novo processo CLI para o Teapot Router. Não altera ~/.codex/config.toml nem o início de sessão atual. Mais tarde pode continuar a abrir Codex normalmente e escolher Teapot Router por sessão.

  1. Confirme o saldo da conta real e prepare uma chave API válida.
  2. Peça ao administrador para ativar um canal e modelo compatíveis com Responses.
  3. Escolha abaixo a chave e o modelo; copie o comando pronto para um novo terminal. A pré-visualização oculta a chave, mas o comando copiado inclui-a.
  4. Peça ao Codex para responder OK e confirme o pedido em Utilização.

Preparar comando Codex

Escolha uma chave e um modelo para este teste.

O sistema altera apenas a sintaxe. Escolha manualmente para outro computador.

Instala um perfil Teapot Router separado no macOS. A configuração Codex atual mantém-se.

A carregar…

Alternativa: introduzir endereço, modelo e chave
(
  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}"
)

O comando afeta apenas esta sessão. A chave pode ficar no clipboard e no histórico do terminal; limpe-os após o teste. Verifique o NEW-API em caso de erro de modelo ou canal.

Crédito de teste e pagamentos
03 / Claude Code

Claude Code

Este método configura o Claude Code apenas na sessão atual do terminal e não substitui definições existentes.

  1. Se ainda não tem Claude Code, siga as instruções oficiais de instalação e confirme que o comando claude abre.
  2. No painel Teapot Router, abra « Configurar cliente » → Claude Code. Copie o endereço sem /v1, revele a chave e obtenha um ID de modelo Claude disponível.
  3. Abra o terminal. Substitua <TEAPOT_API_BASE_URL> e <CLAUDE_MODEL_ID> pelos seus valores. Execute os comandos, cole a chave quando for pedido e prima Enter. A chave não aparece no ecrã.
  4. Envie uma mensagem curta no Claude Code, por exemplo « Responde OK ». Depois encontre o pedido no histórico de utilização 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

As variáveis duram apenas nesta sessão do terminal. Para guardar a configuração, use um método suportado pelo Claude Code e faça uma cópia das definições atuais antes de as alterar.

04 / Cliente compatível com OpenAI

Cliente compatível com OpenAI

Para aplicações de chat com fornecedor OpenAI personalizado ou aplicações com o SDK OpenAI. Os nomes dos menus variam; os três valores são os mesmos.

  1. Abra as definições de fornecedor ou API do cliente e escolha « OpenAI compatible », « Custom OpenAI » ou uma API personalizada.
  2. Em « Base URL », introduza o endereço do separador OpenAI compatível do Teapot Router, terminado em /v1. Em « API Key », coloque a chave real revelada.
  3. Introduza o ID completo de um modelo permitido para a chave. Guarde, envie uma mensagem curta e confirme o pedido no Teapot Router.
Campo do clienteValor a introduzir
Base URL / endereço APIA raiz do gateway Teapot Router seguida de /v1; copie-a da janela de configuração.
API KeyA chave real criada e revelada no Teapot Router.
Model / modeloO ID completo do modelo disponível para esta chave, com a mesma grafia.
Para programadores: teste mínimo em Python

Se não tiver um cliente gráfico, instale o pacote Python openai e execute este exemplo. O endereço, a chave e o modelo são pedidos sem gravar a chave no código.

# 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 / Confirmar ligação

Confirmar ligação

Copiar os valores ou marcar « Cliente configurado » não prova que o pedido funcionou. Confirme uma chamada real.

  1. O cliente apresenta uma resposta do modelo, não apenas « definições guardadas ».
  2. No histórico de utilização Teapot Router, encontre o pedido com hora, modelo e chave correspondentes.
  3. Na visão geral, clique em « Verificar chamada ». Se for a primeira chamada da conta, a terceira etapa muda. Caso contrário, atualize e confirme a conta.
Confirmar ligação
06 / Resolver problemas

Resolver problemas

401 / chave inválida

Use uma chave real desta conta, ativa e dentro do prazo. Confirme que o endereço API não é o endereço do site.

Modelo não encontrado / sem canal

O modelo tem de estar ativo e disponível para o grupo da chave. Peça a verificação do canal. Adicionar saldo não cria um canal.

Saldo ou quota da chave insuficiente

Verifique o saldo em Faturação e, se houver limite próprio da chave, a quota restante.

O cliente responde, mas o progresso não muda

Atualize a utilização e a visão geral e confirme que usou a mesma conta.

Continua com dificuldades? Envie ao suporte o nome do cliente, o erro e a hora. Nunca envie a chave API completa.