Como usar um revendedor de API no Codex
Configure um provedor de modelo personalizado no ~/.codex/config.toml.
2 min de leitura
O Codex CLI lê o ~/.codex/config.toml ao iniciar. Ao definir um “provedor de modelo (model provider)” personalizado, é possível conectar o Codex a um revendedor de API compatível com a interface da OpenAI.
Informações necessárias
Obtenha as seguintes informações na plataforma de API que você usa:
- Endereço da API (URL base): o endereço raiz da interface fornecido pela plataforma, normalmente terminado em
/v1 - Chave de API (Key): a credencial usada para autenticação
- Nome do modelo: o identificador do modelo que a plataforma oferece e que você pretende usar
Configurar o config.toml
Edite o ~/.codex/config.toml, acrescente um provedor personalizado e defina-o como padrão:
model = "your-model-name" # substitua pelo nome de modelo que a plataforma oferece
model_provider = "thirdparty" # identificador do provedor personalizado, à sua escolha (não use openai/ollama/lmstudio)
[model_providers.thirdparty]
name = "Third-party API"
base_url = "https://example.com/v1" # substitua pelo endereço da API fornecido pela plataforma
env_key = "THIRDPARTY_API_KEY" # nome da variável de ambiente que guarda a chave
wire_api = "chat" # endpoints compatíveis de terceiros costumam usar chat
O env_key indica o “nome da variável de ambiente que guarda a chave”, e não a chave em si. Exporte essa variável no terminal:
export THIRDPARTY_API_KEY="your-key"
Perguntas frequentes
- Falha na validação da chave: se o prefixo da chave da plataforma for diferente do da OpenAI e, por isso, a chave for recusada, acrescente
requires_openai_auth = falsena configuração desse provedor. - Escolha do protocolo: endpoints compatíveis de terceiros geralmente usam
wire_api = "chat"(que corresponde a/chat/completions). - Não escreva a chave no config.toml: use
env_keypara apontar para uma variável de ambiente, evitando que a chave vaze junto com o arquivo de configuração. - Apenas troca temporária: se você quiser mudar o endereço somente por um tempo, defina a variável de ambiente
OPENAI_BASE_URLpara substituí-lo na sessão atual.