Pular para o conteúdo
Recursos para Desenvolvedores
Recursos para Desenvolvedores

Codex App

Use o RunAPI como provedor de modelo no Codex App, escolha um modelo compatível com Responses e verifique a conexão.

Ver Markdown

Visão geral

O Codex está disponível no aplicativo desktop do ChatGPT para Windows e macOS. Este guia direciona o Codex App local para o endpoint Responses compatível com OpenAI do RunAPI, seleciona um modelo do RunAPI e verifica a conexão.

Isso altera o provedor de modelo usado para gerar respostas e código. Não adiciona ferramentas do RunAPI. O MCP Hospedado é uma integração separada com seus próprios requisitos de cliente e Autenticação.

Antes de começar

Estas etapas configuram clientes Codex locais que leem sua configuração em nível de usuário. Elas não configuram tarefas hospedadas na nuvem do Codex.

Salvar a Chave de API

Aplicativos desktop podem não herdar variáveis de ambiente do seu shell. Crie ou edite ~/.codex/.env e adicione a chave em sua própria linha:

DOTENV 
export RUNAPI_API_KEY=YOUR_RUNAPI_API_KEY

Mantenha este arquivo fora dos seus repositórios. No macOS e Linux, restrinja-o à sua conta de usuário:

SHELL 
chmod 600 ~/.codex/.env

Configurar o RunAPI

Abra o ~/.codex/config.toml no nível do usuário. Mescle os seguintes valores no arquivo existente; não substitua configurações não relacionadas nem adicione uma segunda cópia de uma chave de nível superior já existente:

TOML 
model = "YOUR_RUNAPI_MODEL_ID"
model_provider = "runapi"

[model_providers.runapi]
name = "RunAPI"
base_url = "https://runapi.ai/v1"
env_key = "RUNAPI_API_KEY"
wire_api = "responses"

As configurações de provedor e autenticação devem ser no nível do usuário. O Codex ignora model_provider e model_providers no .codex/config.toml de um projeto. O TOML armazena apenas o nome da variável de ambiente; a chave de API permanece em ~/.codex/.env.

O base_url é a raiz da API, não uma URL de operação. Com wire_api = "responses", o Codex envia POST /v1/responses. Consulte a configuração de provedor de modelo personalizado da OpenAI para o contrato do provedor.

Escolher um modelo

Substitua YOUR_RUNAPI_MODEL_ID pelo identificador exato copiado do Catálogo de Modelos. Selecione um modelo que exponha a Responses API; suporte apenas a Chat Completions não é suficiente para esta configuração.

Quando você altera o model, reinicie completamente o aplicativo e inicie uma nova tarefa. Uma tarefa existente pode manter o modelo e o provedor com os quais foi iniciada.

Reiniciar e verificar

  1. Feche completamente e reabra o aplicativo desktop do ChatGPT.
  2. Abra o Codex e inicie uma nova tarefa em um repositório.
  3. Envie um prompt curto, como Describe this repository in one sentence.
  4. Confirme que o Codex retorna uma resposta normal e que o RunAPI registra uma requisição POST /v1/responses para o modelo selecionado.

A primeira verificação deve ser breve para que erros de configuração sejam fáceis de distinguir de comportamentos específicos da tarefa.

Adicionar ferramentas RunAPI

O provedor de modelo acima roteia a inferência do Codex pelo RunAPI. MCP é separado: ele pode permitir que clientes suportados chamem ferramentas do RunAPI para descoberta de modelos, informações de conta e fluxos de trabalho de tarefas suportados.

O guia de MCP Hospedado documenta os requisitos atuais de cliente e Autenticação. A Autenticação de MCP Hospedado específica para Codex não foi verificada, portanto esta página não fornece as etapas de configuração do MCP para Codex. Não substitua a configuração do provedor de modelo por uma entrada de servidor MCP; as duas integrações atendem a finalidades diferentes.

Solucionar problemas

  • Codex ainda usa o provider anterior: confirme que o arquivo é ~/.codex/config.toml, remova chaves model ou model_provider duplicadas, reinicie o aplicativo completamente e inicie uma nova tarefa.
  • RUNAPI_API_KEY está ausente: confirme que a chave está em ~/.codex/.env, não apenas em um perfil de terminal, e reinicie o aplicativo.
  • A autenticação falha: crie ou rotacione uma chave padrão pelo Guia de Autenticação. Não cole a chave no config.toml nem em logs de suporte.
  • A requisição retorna 404: defina base_url como https://runapi.ai/v1, não https://runapi.ai/v1/responses.
  • O modelo está indisponível ou rejeita um campo: copie o identificador exato novamente e confirme que o modelo suporta a Responses API e a capacidade solicitada.
  • Codex seleciona um modelo diferente: verifique os arquivos .codex/config.toml de projetos confiáveis por uma substituição de model. A configuração de projeto pode selecionar um modelo, embora não possa substituir o provider definido no nível do usuário.
  • A CLI funciona, mas o aplicativo falha: verifique ~/.codex/.env e reinicie completamente o aplicativo. Aplicativos GUI podem não ler variáveis exportadas apenas pelo shell.
  • Uma tarefa em nuvem não usa RunAPI: esta configuração local se aplica a clientes Codex locais; tarefas em nuvem hospedadas não leem arquivos do seu computador.

Remover RunAPI

  1. Remova os valores model, model_provider e [model_providers.runapi] do RunAPI em ~/.codex/config.toml, ou restaure os valores do provedor utilizados anteriormente.
  2. Remova RUNAPI_API_KEY de ~/.codex/.env se nenhuma outra ferramenta local o utilizar.
  3. Reinicie completamente o aplicativo e inicie uma nova tarefa.
  4. Revogue a chave dedicada no RunAPI quando ela não for mais necessária.

Próximas etapas

Use o Início rápido da LLM API para o comportamento compartilhado do protocolo e a Referência da API Responses para os campos exatos de requisição e resposta. Continue com o Catálogo de Modelos, o Guia de Autenticação ou o MCP Hospedado conforme necessário.