Usar Codex com CometAPI

Use este guia para executar o Codex com a CometAPI como provedor de modelo. Referências oficiais:

Pré-requisitos

Requisito	Detalhes
SO	macOS, Linux, Windows PowerShell nativo ou Windows com WSL
Git	2.23+ recomendado
Codex	Instale o app Codex ou o Codex CLI a partir do início rápido do Codex
Chave de API da CometAPI	Obtenha uma no painel da CometAPI
Model ID	Use um model ID da página de modelos

Escolha um caminho de configuração

Oferecemos duas opções para ajudar você a configurar o Codex rapidamente.

Opção 1: Configurar o Codex manualmente (recomendado)

Edite diretamente o arquivo ~/.codex/config.toml em nível de usuário. Este é o caminho mais confiável, especialmente para usuários de Windows e WSL.

Opção 2: Configurar via script

Execute o script de configuração como atalho. Ele grava a mesma configuração de provedor e armazena a chave de API da CometAPI para o Codex.

Configurar o Codex manualmente

O Codex lê os padrões pessoais de provider do arquivo ~/.codex/config.toml no nível do usuário. Configure o provider CometAPI nele, não em um arquivo .codex/config.toml do projeto. O Codex ignora as configurações de provider e provider-auth em arquivos de configuração do projeto. A configuração recomendada usa um provider nomeado cometapi e autenticação baseada em comando. Isso mantém o CometAPI separado do provider OpenAI integrado, não exige herança de variáveis de ambiente do shell e não substitui ~/.codex/auth.json.

macOS / Linux / WSL
Windows PowerShell

Armazene sua chave de API do CometAPI em um arquivo de chave local:

mkdir -p "$HOME/.codex"
printf "%s\n" "$COMETAPI_KEY" > "$HOME/.codex/cometapi_key"
chmod 600 "$HOME/.codex/cometapi_key"

Adicione esta configuração a ~/.codex/config.toml:

model_provider = "cometapi"
model = "your-model-id"

[model_providers.cometapi]
name = "CometAPI"
base_url = "https://api.cometapi.com/v1"
wire_api = "responses"

[model_providers.cometapi.auth]
command = "sh"
args = ["-c", "cat \"$HOME/.codex/cometapi_key\""]

Armazene sua chave de API do CometAPI no diretório inicial do Codex no Windows:

New-Item -ItemType Directory -Force "$HOME\.codex" | Out-Null
Set-Content -NoNewline -Path "$HOME\.codex\cometapi_key" -Value $env:COMETAPI_KEY

Adicione esta configuração a $HOME\.codex\config.toml:

model_provider = "cometapi"
model = "your-model-id"

[model_providers.cometapi]
name = "CometAPI"
base_url = "https://api.cometapi.com/v1"
wire_api = "responses"

[model_providers.cometapi.auth]
command = "powershell.exe"
args = [
  "-NoProfile",
  "-Command",
  "$p=Join-Path $HOME '.codex/cometapi_key'; (Get-Content -Raw $p).Trim()",
]

O Codex nativo do Windows usa $HOME\.codex, geralmente C:\Users\<user>\.codex. O WSL usa o ~/.codex da distribuição Linux. Edite o diretório que corresponde ao ambiente em que o agente Codex é executado.

Usar autenticação por variável de ambiente

Se você preferir manter a chave de API do CometAPI em uma variável de ambiente, use env_key em vez do bloco [model_providers.cometapi.auth]. Use esta configuração de provider somente quando COMETAPI_KEY estiver disponível no ambiente que inicia o Codex:

model_provider = "cometapi"
model = "your-model-id"

[model_providers.cometapi]
name = "CometAPI"
base_url = "https://api.cometapi.com/v1"
wire_api = "responses"
env_key = "COMETAPI_KEY"

Não combine env_key com [model_providers.cometapi.auth]. O Codex oferece suporte a um método de autenticação por provider personalizado.

Execute o script de configuração

O script de configuração é opcional. Ele grava a mesma configuração do provider cometapi em ~/.codex/config.toml, armazena sua chave de API da CometAPI em ~/.codex/cometapi_key, cria backups antes de alterar arquivos e verifica a configuração com codex exec quando o Codex CLI está disponível. Para macOS, Linux ou WSL, execute o instalador interativo:

sh -c "$(curl -fsSL https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.sh)"

Para uma configuração não interativa, passe a chave de API explicitamente:

curl -fsSL https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.sh | sh -s -- --key "$COMETAPI_KEY"

Para PowerShell nativo no Windows, execute o instalador interativo:

powershell -c "irm 'https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.ps1' | iex"

Para uma configuração não interativa no Windows, passe a chave de API explicitamente:

powershell -c "& ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.ps1'))) -Key $env:COMETAPI_KEY"

Por padrão, o script não substitui ~/.codex/auth.json nem remove um login do ChatGPT. Use --force-auth-json ou -ForceAuthJson apenas se quiser que o script gerencie o login por chave de API do Codex por meio de auth.json.

Escolha ou altere um model ID

Use um model ID da página Models. Na configuração manual, altere o valor de model em ~/.codex/config.toml. Para macOS, Linux ou WSL, passe --model ao executar o script de configuração:

curl -fsSL https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.sh | sh -s -- --key "$COMETAPI_KEY" --model your-model-id

Para PowerShell nativo no Windows, passe -Model ao executar o script de configuração:

powershell -c "& ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.ps1'))) -Key $env:COMETAPI_KEY -Model 'your-model-id'"

O script usa CODEX_HOME quando ele está definido. Caso contrário, ele grava no ~/.codex do ambiente atual.

Verifique a configuração

Para verificar a configuração com o Codex CLI, execute este comando somente leitura em qualquer projeto local:

codex exec --ephemeral --skip-git-repo-check --sandbox read-only --color never "Reply exactly with: COMETAPI_CODEX_OK"

Se o Codex CLI não estiver disponível no PATH, abra o app Codex e envie um prompt curto a partir de um projeto local.

Solução de problemas

O Codex ainda usa o provedor OpenAI padrão

Confirme que model_provider = "cometapi" está no arquivo ~/.codex/config.toml no nível do usuário.

A chave de API mudou

Atualize ~/.codex/cometapi_key ou execute novamente o script de configuração com o valor atualizado de $COMETAPI_KEY.

O script do PowerShell falha durante as verificações preliminares

Use as etapas manuais nativas do PowerShell no Windows e, em seguida, execute o comando de verificação.

A configuração do shell com pipe não pede nenhuma chave de API

Use --key "$COMETAPI_KEY", defina COMETAPI_KEY ou execute o comando interativo sh -c "$(curl ...)".

A conexão expira ou usa a base URL errada

Confirme que base_url é https://api.cometapi.com/v1 em ~/.codex/config.toml.

O model não é encontrado

Verifique a página de Models para ver os model IDs disponíveis.

A configuração do Windows afeta o ambiente errado

Edite $HOME\.codex para o modo nativo do Windows ou edite ~/.codex dentro do WSL para o modo de agente WSL.

Visão Geral

Agentes de programação de IA

Agentes de IA

Clientes de chat de IA

Tradução e idioma

Plataformas de automação

Observabilidade e avaliação

Frameworks de IA

Pré-requisitos

Escolha um caminho de configuração

Opção 1: Configurar o Codex manualmente (recomendado)

Opção 2: Configurar via script

Configurar o Codex manualmente

Usar autenticação por variável de ambiente

Execute o script de configuração

Escolha ou altere um model ID

Verifique a configuração

Solução de problemas

​Pré-requisitos

​Escolha um caminho de configuração

Opção 1: Configurar o Codex manualmente (recomendado)

Opção 2: Configurar via script

​Configurar o Codex manualmente

​Usar autenticação por variável de ambiente

​Execute o script de configuração

​Escolha ou altere um model ID

​Verifique a configuração

​Solução de problemas

Pré-requisitos

Escolha um caminho de configuração

Configurar o Codex manualmente

Usar autenticação por variável de ambiente

Execute o script de configuração

Escolha ou altere um model ID

Verifique a configuração

Solução de problemas