Connect Codex

Configure an Orbis Responses route in a separate profile, keep your existing login and verify chat, follow-ups and file tools.

Connect Codex CLI to an Orbis GPT route. For installation, a first file task and further practice, see the illustrated Codex beginner guide.

1. Get a key for a Responses route

In Models, choose a GPT text model such as GPT-6.1 Sol, then create a key for a route supporting OpenAI Responses. The key determines the route; changing only the model name does not switch routes.

Codex needs Responses streaming, follow-up conversations and tool calls. These instructions do not apply directly to routes that only support Chat Completions, or to GPT image models.

2. Create a separate configuration

Run codex --version first. This setup uses separate profile files in 0.134.0 or later, keeping your default configuration in place.

Create ~/.codex/orbis.config.toml, or %USERPROFILE%\.codex\orbis.config.toml on Windows. If it already exists, back it up and merge these settings:

model = "gpt-6.1-sol"
model_provider = "orbis"
web_search = "disabled"

[model_providers.orbis]
name = "Orbis"
base_url = "https://api.orbiorbi.com/v1"
wire_api = "responses"
env_key = "ORBIS_API_KEY"

Keep /v1 in the URL; do not append /responses. env_key is the variable name, not the key itself. Keep the first three settings above the table header, outside the old [profiles.orbis] section. Start with web search disabled, then check the route's additional capabilities after connecting.

Check the current model and settings under the route's Quick access → Tools → Codex CLI tab. If your Codex version does not recognize the model, use the matching model catalog supplied by the route. Do not substitute an arbitrary model alias or reference a catalog file that does not exist.

3. Enter the key and start the profile

Open a terminal in your project directory. Paste the key when prompted; the input is hidden.

$env:ORBIS_API_KEY = [System.Net.NetworkCredential]::new('', (Read-Host 'Paste your Orbis key' -AsSecureString)).Password
codex --profile orbis

# Zsh, the default shell on macOS
printf 'Paste your Orbis key: '
read -rs ORBIS_API_KEY
printf '\n'
export ORBIS_API_KEY
codex --profile orbis

Enter the key again in a new terminal. Resume a session with codex --profile orbis resume. To return to your default configuration, exit and run codex without the profile flag. Project and managed settings can still affect the effective configuration.

4. Verify a real request

1. Run /status and check the provider, model and directory.
2. Send “Reply with OK only.” Check the actual model, route and charge in Usage logs. This request uses API allowance.
3. Ask Codex to read a small practice file, then send a follow-up message to check both tool calls and conversation continuation.

This setup is for the CLI. An app launched from a desktop icon does not automatically inherit terminal variables. For other client surfaces, see the official gateway guide. For installation and complete task examples, see the illustrated tutorial.