<!-- Generated from public website sources; do not edit this file. -->

> DSSUB design reference. Account, payments and API are not connected; prices, policies and setup examples require independent launch verification.

# Codex
Prepare one provider and a two-model picker for Codex CLI.

## Current availability
DSSUB is a design preview. These are complete configuration references, not a live connection: `api.dssub.invalid` is intentionally non-routable. No real account, key, payment or inference service is connected. Replace the endpoint and use an authorized key only after DSSUB publishes verified connection details. Client versions and live tool compatibility remain unverified.

## Install and check your version
Follow the [official installation guide](https://developers.openai.com/codex/cli). Record `codex --version` before testing. This template requires Responses at `/v1/responses`.

## Prepare your key
When a real endpoint is available, supply its authorized key in the same terminal that starts the tool. The following value is a placeholder.

### macOS or Linux
```sh
export DSSUB_API_KEY="YOUR_DSSUB_API_KEY"
```

### Windows PowerShell
```powershell
$env:DSSUB_API_KEY = "YOUR_DSSUB_API_KEY"
```

Do not add a real key to a shared project or downloaded template. Desktop applications may not inherit terminal environment variables; use their supported credential setup.

## Save the provider configuration
Download the template ZIP above. Back up `~/.codex/config.toml`, then merge `dssub.config.toml` into it. Save `dssub-models.json` beside that file and replace the absolute catalog path. On Windows, use a forward-slash absolute path such as `C:/Users/YOUR_NAME/.codex/dssub-models.json`.

The top-level provider and catalog settings change defaults, including the model picker. Preserve your old values so you can restore them. The catalog exposes two preview IDs with conservative text-only metadata; it does not certify tool or reasoning support.

```toml
# Preview only. Merge carefully; preserve your existing configuration.
model_provider = "dssub"
model = "deepseek-flash"
model_catalog_json = "/ABSOLUTE/PATH/TO/dssub-models.json"
web_search = "disabled"

[model_providers.dssub]
name = "DSSUB preview"
base_url = "https://api.dssub.invalid/v1"
wire_api = "responses"
env_key = "DSSUB_API_KEY"
requires_openai_auth = false

[profiles.dssub]
model_provider = "dssub"
model = "deepseek-flash"
```

### Required model catalog
```json
{
  "models": [
    {
      "slug": "deepseek-flash",
      "display_name": "DeepSeek V4.1 Flash",
      "description": "DSSUB preview template; live compatibility pending",
      "default_reasoning_level": "none",
      "supported_reasoning_levels": [],
      "shell_type": "unified_exec",
      "visibility": "list",
      "supported_in_api": true,
      "priority": 0,
      "base_instructions": "Follow the user instructions and configured permissions. Verify work before reporting completion.",
      "supports_reasoning_summaries": false,
      "supports_reasoning_summary_parameter": false,
      "support_verbosity": false,
      "default_verbosity": null,
      "apply_patch_tool_type": null,
      "truncation_policy": {
        "mode": "bytes",
        "limit": 10000
      },
      "experimental_supported_tools": [],
      "input_modalities": [
        "text"
      ]
    },
    {
      "slug": "deepseek-v4-pro",
      "display_name": "DeepSeek V4 Pro",
      "description": "DSSUB preview template; live compatibility pending",
      "default_reasoning_level": "none",
      "supported_reasoning_levels": [],
      "shell_type": "unified_exec",
      "visibility": "list",
      "supported_in_api": true,
      "priority": 1,
      "base_instructions": "Follow the user instructions and configured permissions. Verify work before reporting completion.",
      "supports_reasoning_summaries": false,
      "supports_reasoning_summary_parameter": false,
      "support_verbosity": false,
      "default_verbosity": null,
      "apply_patch_tool_type": null,
      "truncation_policy": {
        "mode": "bytes",
        "limit": 10000
      },
      "experimental_supported_tools": [],
      "input_modalities": [
        "text"
      ]
    }
  ]
}
```

## Start Codex
From your test project, run:

```sh
codex --profile dssub --model deepseek-flash
```

For Desktop, merge the same provider and catalog fields into its local configuration, then restart and use a new local task. An environment key must be available to the app process; a terminal export alone is not proof of Desktop authentication.

## Switch models
Inside a session, open `/model` and choose DeepSeek V4.1 Flash or DeepSeek V4 Pro. For a new CLI session, use `codex --profile dssub --model deepseek-v4-pro`. These are preview IDs; no live access is granted.

## Choose reasoning effort
Codex displays effort choices for models whose catalog declares supported levels. This template declares no verified DSSUB levels and leaves global `model_reasoning_effort` unset. After a gateway contract is verified, update the model catalog and select an allowed effort through `/model`. Do not copy another provider’s effort levels or context limits.

## Verify your first request
After a live connection is published, start a new session in a small test project. First ask for a short text reply. Then ask the tool to read README.md and summarize it without modifying files. Confirm the selected provider and model, then match the request in [Usage](/account/usage). Check tool results, streaming completion and billed tokens separately. The current sample dashboard cannot verify a real request.

## Troubleshoot and restore
A DNS failure for `api.dssub.invalid` is expected in this preview. For a real connection, check the exact endpoint, API format, model ID and credential. A 401 concerns authentication; a 404 may concern a path or model; a 429 may concern a quota or rate limit. See [troubleshooting](/docs/error-codes/index.md).

Back up configuration before editing, merge only DSSUB fields, and retain your existing providers and permissions. To revert, select your previous provider and restore only the fields you changed. Stop and restart the tool after changing its startup environment.

## Reference
Reviewed November 16, 2026 against the [official configuration reference](https://developers.openai.com/codex/config-reference/).

---

HTML source: [Codex — dssub Tutorials](/docs/codex/)
