Agent Quick Start
Connect Codex CLI to Tokatlas
Configure Codex CLI with a Tokatlas key, endpoint, and enabled model.
Before You Start
Install from the official CLI guide, then check codex --version. npm installation: npm install -g @openai/codex.
Prepare a Tokatlas API key and a model enabled for your account. Replace all YOUR_... placeholders. Back up existing settings before merging changes.
Connection Settings
| Setting | Value |
|---|---|
| Provider name | Tokatlas |
| Protocol | Responses |
| Endpoint / Base URL | https://api.tokatlas.ai/v1 |
| API Key | YOUR_TOKATLAS_API_KEY |
| Model ID | YOUR_TOKATLAS_MODEL_ID |
Setup
- Back up and merge the configuration below into user-level
~/.codex/config.toml(Windows:%USERPROFILE%\.codex\config.toml). Replace the model placeholder. - Set
TOKATLAS_API_KEYin the launching terminal: Bash/Zsh usesexport TOKATLAS_API_KEY="YOUR_TOKATLAS_API_KEY"; PowerShell uses$env:TOKATLAS_API_KEY = "YOUR_TOKATLAS_API_KEY". - Run
codexin a project and check/status. Create a new conversation after changing the model.
Configuration Example
toml
model = "YOUR_TOKATLAS_MODEL_ID"
model_provider = "tokatlas"
web_search = "disabled"
[model_providers.tokatlas]
name = "Tokatlas"
base_url = "https://api.tokatlas.ai/v1"
wire_api = "responses"
env_key = "TOKATLAS_API_KEY"Compatibility Notes
Keep top-level settings before the first table. Do not duplicate existing keys. The chosen model must support Codex’s Responses and tool flow; custom aliases may need a matching model catalog. See Codex Desktop for desktop credential handling.
Verify and Troubleshoot
- Open a new conversation and send “Reply with OK only”; check that text returns.
- Check Tokatlas usage for a successful request at the same time with the configured model.
- If you need tools, ask the client to list files in a test directory and check that the tool result returns to the conversation.
- If step 1 fails, test the key and model directly using API Basics. If that succeeds, troubleshoot client settings below.
| Problem | Check |
|---|---|
401 / 403 | Re-enter the Tokatlas key without quotes or spaces; check the auth mode and model access. |
404 | Compare the full request URL with the table above; remove a duplicated /v1 or endpoint suffix. |
| Unknown model | Copy an enabled ID from the model list, save it, and select that model in a new chat. |
| Tool failure | Model capabilities and client protocol support. |
| Changes ignored | Select the Tokatlas provider/profile, fully quit the client, and reopen it. |
