Use NexRouter with Codex CLI
Connect Codex CLI with your site API address, key, and model.
Follow these steps to use your NexRouter key and model in Codex CLI.
Not installed yet? Follow the official guide first, then return here.
1. Get three things ready
- API address: open this site’s connection settings and copy the address required below.
- API key: create or copy a key in API key management. Do not use your login password.
- Model ID: copy the exact ID from the model list, not its display name.
Use an address and key from the same site. Domestic and overseas credentials are separate.
2. Configure Codex CLI
Replace these values in the example; do not leave YOUR_... unchanged:
| Placeholder | Replace with |
|---|---|
YOUR_API_BASE_URL | The OpenAI Base URL including /v1 from connection settings |
YOUR_API_KEY | The full API key you copied |
YOUR_MODEL_ID | The exact model ID you copied |
Merge this into ~/.codex/config.toml. Keep top-level fields before the first table and do not duplicate existing keys:
model = "YOUR_MODEL_ID"
model_provider = "nexrouter"
web_search = "disabled"
[model_providers.nexrouter]
name = "NexRouter"
base_url = "YOUR_API_BASE_URL"
wire_api = "responses"
env_key = "NEXROUTER_API_KEY"
requires_openai_auth = falseKeep /v1 in YOUR_API_BASE_URL; do not append /responses. Choose a model that supports Responses.
Set the key in the terminal that launches Codex:
export NEXROUTER_API_KEY='YOUR_API_KEY'
codexRun /status to check the active model and provider.
3. Send a test message
Select the model you just configured, open a new chat, and send:
Please reply with only: ConnectedA normal reply means your first connection worked. You can now start your own task.
If no reply arrives, check the error:
- 401 / API key error: copy the full key again and check that the address and key belong to the same site.
- 404 / endpoint not found: compare the URL with the format above, especially missing or repeated
/v1. - Model not found: copy the exact model ID again and check that your key has access.
See Troubleshooting for other errors. To check the API separately, use the first request example.
Learn more
For installation, complete settings, and advanced features, see the official Codex CLI documentation.