> ## Documentation Index
> Fetch the complete documentation index at: https://novita.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Codex

> Conecte o Codex ao endpoint da API de LLM compatível com OpenAI da Novita.

Codex é uma ferramenta de codificação com IA que é executada no seu terminal. Você pode conectar o Codex ao endpoint da API de LLM compatível com OpenAI da Novita e usar os modelos da Novita para tarefas de compreensão, geração, refatoração e depuração de código.

<Warning>
  Atualmente, o Codex oferece suporte apenas à Responses API. Configure `wire_api = "responses"` conforme mostrado abaixo e não altere esta integração para o modo Chat Completions.
</Warning>

## Pré-requisitos

Antes de começar, prepare os seguintes valores:

* **Chave de API**: Crie ou copie uma chave de API em [Gerenciamento de Chaves](https://novita.ai/settings/key-management).
* **URL base**: `https://api.novita.ai/openai/v1`
* **ID do modelo**: Copie o ID do modelo que você deseja usar no Model Hub, como `deepseek/deepseek-v3.1`.

<Tip>
  Mantenha sua chave de API privada. Use-a apenas na configuração local do Codex e nunca a envie para um repositório Git.
</Tip>

## Instalar o Codex

Antes de instalar o Codex, certifique-se de que o [Node.js 18 ou superior](https://nodejs.org/en/download/) esteja instalado na sua máquina.

No macOS, se você usa Homebrew, pode instalar o Node.js com:

```bash theme={"system"}
brew install node
```

Verifique suas versões do Node.js e do npm:

```bash theme={"system"}
node -v
npm -v
```

Instale a CLI do Codex:

```bash theme={"system"}
npm install -g @openai/codex
```

Verifique a versão do Codex:

```bash theme={"system"}
codex --version
```

## Configurar sua chave de API

Abra o arquivo de configuração do seu shell, por exemplo `~/.zshrc`:

```bash theme={"system"}
nano ~/.zshrc
```

Adicione a seguinte variável de ambiente:

```bash theme={"system"}
export NOVITA_API_KEY="<your-novita-api-key>"
```

Recarregue a configuração do shell e confirme que a variável está disponível:

```bash theme={"system"}
source ~/.zshrc
echo $NOVITA_API_KEY
```

## Configurar o Codex

Abra o arquivo de configuração do Codex:

```bash theme={"system"}
mkdir -p ~/.codex
nano ~/.codex/config.toml
```

Adicione a seguinte configuração e substitua `model` pelo ID do modelo da Novita que você deseja usar:

```toml theme={"system"}
model_provider = "novita"
model = "deepseek/deepseek-v3.1"

[model_providers]
[model_providers.novita]
name = "Novita"
wire_api = "responses"
requires_openai_auth = true
base_url = "https://api.novita.ai/openai/v1"
env_key = "NOVITA_API_KEY"
```

## Iniciar o Codex

Acesse o diretório do seu projeto e inicie o Codex:

```bash theme={"system"}
cd <your-project-directory>
codex
```

Agora você pode inserir uma tarefa de codificação, por exemplo:

```text theme={"system"}
Read this project and summarize the main modules.
```

Se o Codex retornar um erro de autenticação ou de modelo, verifique se:

* `NOVITA_API_KEY` está disponível na sessão atual do terminal.
* `model` corresponde exatamente ao ID do modelo no Model Hub da Novita.
* `base_url` está definido como `https://api.novita.ai/openai/v1`.