API Documentation

Official-Compatible Model APIs

CodexAPI.pro exposes additive compatibility endpoints for coding clients that expect the official OpenAI and Anthropic-style HTTP surfaces. These endpoints use the same wallet, internal rate cards, model-selection policy, and live routing source of truth as the existing CLI endpoints.

• POST /v1/responses creates Responses API generations for ChatGPT-5.5, including streaming, tools, MCP-style function tools, and web-search capable payloads where the selected upstream supports them.
• POST /v1/chat/completions accepts OpenAI Chat Completions payloads and adapts them into the active Responses route, so it works across the currently configured runtime path.
• POST /v1/completions supports legacy text-completion clients by adapting prompts into the same Responses route.
• POST /v1/messages and POST /v1/messages/count_tokens provide Anthropic-compatible Claude Code access for Opus 4.8 with local client tools preserved.
• GET /v1/models, GET /v1/models/{model}, response lookup, response input item listing, chat-completion listing, chat-completion retrieval, update, and delete endpoints are included for SDK compatibility.

Official OpenAI Codex CLI

Use the customer's Codex API username with the official OpenAI package installed by npm install -g @openai/codex@0.142.2. The API compatibility target is Codex CLI 0.142.2. Do not run codex login for CodexAPI.pro; configure CodexAPI.pro as a custom Responses provider and save the username in ~/.codex/config.toml using the dashboard's one-time setup command.

After the one-time setup has written CodexAPI.pro into the normal Codex config, users can return with codex, codex --search, codex resume --search, or any other normal Codex opening command without repeating API setup.

For non-interactive live-search runs, use codex --search exec .... The current official CLI rejects codex exec --search ....

The dashboard returns a token-specific command after creation; the generic provider shape is:

{
  "providerId": "codexapi",
  "providerName": "CodexAPI.pro",
  "officialCliVersion": "0.142.2",
  "officialInstallTag": "0.142.2",
  "officialInstallCommand": "npm install -g @openai/codex@0.142.2",
  "baseUrl": "https://api-chicago.codexapi.pro/v1",
  "envKey": "CODEXAPI_CODEX_API_KEY",
  "wireApi": "responses",
  "model": "gpt-5.5",
  "reasoningEffort": "high",
  "modelsUrl": "https://api-chicago.codexapi.pro/v1/models",
  "responsesUrl": "https://api-chicago.codexapi.pro/v1/responses",
  "codexHome": "$HOME/.codex",
  "configArgs": [
    "-c 'model_provider=\"codexapi\"'",
    "-c 'model_providers.codexapi.name=\"CodexAPI.pro\"'",
    "-c 'model_providers.codexapi.base_url=\"https://api-chicago.codexapi.pro/v1\"'",
    "-c 'model_providers.codexapi.env_key=\"CODEXAPI_CODEX_API_KEY\"'",
    "-c 'model_providers.codexapi.wire_api=\"responses\"'",
    "-c 'model_providers.codexapi.supports_websockets=false'",
    "-c 'model_reasoning_effort=\"high\"'",
    "-c 'features.apps=false'",
    "-c 'approval_policy=\"never\"'",
    "-c 'sandbox_mode=\"danger-full-access\"'"
  ],
  "persistentConfigToml": "model = \"gpt-5.5\"\nmodel_provider = \"codexapi\"\nmodel_reasoning_effort = \"high\"\napproval_policy = \"never\"\nsandbox_mode = \"danger-full-access\"\n\n[features]\napps = false\n\n[model_providers.codexapi]\nname = \"CodexAPI.pro\"\nbase_url = \"https://api-chicago.codexapi.pro/v1\"\nexperimental_bearer_token = \"<CODEXAPI_API_KEY>\"\nwire_api = \"responses\"\nsupports_websockets = false\n",
  "linuxSetupAndStartCommand": "set -e\nif ! command -v npm >/dev/null 2>&1; then\n  if command -v apt-get >/dev/null 2>&1; then\n    sudo apt-get update\n    sudo apt-get install -y ca-certificates curl gnupg\n    curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -\n    sudo apt-get install -y nodejs git\n  else\n    echo \"Install Node.js LTS and npm first, then rerun this block.\" >&2\n    exit 1\n  fi\nfi\nnpm install -g @openai/codex@0.142.2\nCODEX_HOME_DIR=\"$HOME/.codex\"\nCONFIG_PATH=\"$CODEX_HOME_DIR/config.toml\"\nmkdir -p \"$CODEX_HOME_DIR\" 2>/dev/null || true\nif [ -e \"$CODEX_HOME_DIR\" ] && [ ! -w \"$CODEX_HOME_DIR\" ]; then\n  echo \"Fixing ownership of $CODEX_HOME_DIR for this user...\"\n  if command -v sudo >/dev/null 2>&1; then sudo chown -R \"$(id -u):$(id -g)\" \"$CODEX_HOME_DIR\"; fi\nfi\nif [ -e \"$CONFIG_PATH\" ] && [ ! -w \"$CONFIG_PATH\" ]; then\n  echo \"Fixing ownership of $CONFIG_PATH for this user...\"\n  if command -v sudo >/dev/null 2>&1; then sudo chown \"$(id -u):$(id -g)\" \"$CONFIG_PATH\"; fi\nfi\nmkdir -p \"$CODEX_HOME_DIR\"\nif [ ! -w \"$CODEX_HOME_DIR\" ] || { [ -e \"$CONFIG_PATH\" ] && [ ! -w \"$CONFIG_PATH\" ]; }; then\n  echo \"Cannot write Codex config at $CONFIG_PATH. Run: sudo chown -R \\\"$(id -u):$(id -g)\\\" \\\"$CODEX_HOME_DIR\\\"\" >&2\n  exit 1\nfi\nrm -rf \"$CODEX_HOME_DIR/cache/codex_apps_tools\" 2>/dev/null || true\nCODEXAPI_BACKUP_TS=\"$(date +%Y%m%d%H%M%S)\"\nCODEXAPI_CONFIG_SNIPPET=\"$(mktemp)\"\ncat > \"$CODEXAPI_CONFIG_SNIPPET\" <<'TOML'\nmodel = \"gpt-5.5\"\nmodel_provider = \"codexapi\"\nmodel_reasoning_effort = \"high\"\napproval_policy = \"never\"\nsandbox_mode = \"danger-full-access\"\n\n[features]\napps = false\n\n[model_providers.codexapi]\nname = \"CodexAPI.pro\"\nbase_url = \"https://api-chicago.codexapi.pro/v1\"\nexperimental_bearer_token = \"<CODEXAPI_API_KEY>\"\nwire_api = \"responses\"\nsupports_websockets = false\nTOML\npython3 - \"$CONFIG_PATH\" \"$CODEXAPI_CONFIG_SNIPPET\" <<'PY'\nimport os, re, shutil, sys\nfrom pathlib import Path\n\npath = Path(sys.argv[1]).expanduser()\nsnippet = Path(sys.argv[2]).read_text()\npath.parent.mkdir(parents=True, exist_ok=True)\nif path.exists():\n    shutil.copy2(path, f\"{path}.backup.{os.environ.get('CODEXAPI_BACKUP_TS', 'manual')}\")\noriginal = path.read_text() if path.exists() else \"\"\ntop_keys = {\"model\", \"model_provider\", \"model_reasoning_effort\", \"approval_policy\", \"sandbox_mode\"}\nsection_re = re.compile(r\"^\\s*\\[[^\\]]+\\]\\s*$\")\nkey_re = re.compile(r\"^\\s*([A-Za-z0-9_-]+)\\s*=\")\nsnippet_lines = snippet.strip().splitlines()\nfirst_section = next((i for i, line in enumerate(snippet_lines) if section_re.match(line.strip())), len(snippet_lines))\ntop = snippet_lines[:first_section]\nprovider = []\nfeature_apps = 'apps = false'\ni = first_section\nwhile i < len(snippet_lines):\n    line = snippet_lines[i]\n    if re.match(r\"^\\[model_providers\\.codexapi\\]\\s*$\", line.strip()):\n        provider = snippet_lines[i:]\n        break\n    i += 1\nclean = []\nskip_codexapi = False\nin_section = False\nin_features = False\nfeatures_seen = False\nfor line in original.splitlines():\n    stripped = line.strip()\n    if re.match(r\"^\\[model_providers\\.codexapi\\]\\s*$\", stripped):\n        skip_codexapi = True\n        in_features = False\n        continue\n    if skip_codexapi and section_re.match(stripped):\n        skip_codexapi = False\n    if skip_codexapi:\n        continue\n    if section_re.match(stripped):\n        in_section = True\n        in_features = stripped == '[features]'\n        features_seen = features_seen or in_features\n    if not in_section:\n        m = key_re.match(line)\n        if m and m.group(1) in top_keys:\n            continue\n    if in_features:\n        m = key_re.match(line)\n        if m and m.group(1) == 'apps':\n            continue\n    clean.append(line)\nparts = []\nparts.extend(top)\nparts.append('')\ninserted_feature = False\nfor line in clean:\n    parts.append(line)\n    if line.strip() == '[features]':\n        parts.append(feature_apps)\n        inserted_feature = True\nif not features_seen:\n    if parts and parts[-1] != '':\n        parts.append('')\n    parts.extend(['[features]', feature_apps])\nif provider:\n    if parts and parts[-1] != '':\n        parts.append('')\n    parts.extend(provider)\npath.write_text('\\n'.join(line for line in parts if line is not None).rstrip() + '\\n')\nPY\nrm -f \"$CODEXAPI_CONFIG_SNIPPET\"\necho \"CodexAPI.pro is configured. Future sessions can start with codex or codex resume --search.\"\ncodex --search",
  "macosSetupAndStartCommand": "set -e\nBREW_BIN=\"$(command -v brew 2>/dev/null || true)\"\nif [ -z \"$BREW_BIN\" ] && [ -x /opt/homebrew/bin/brew ]; then BREW_BIN=\"/opt/homebrew/bin/brew\"; fi\nif [ -z \"$BREW_BIN\" ] && [ -x /usr/local/bin/brew ]; then BREW_BIN=\"/usr/local/bin/brew\"; fi\nif [ -z \"$BREW_BIN\" ]; then\n  /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n  if [ -x /opt/homebrew/bin/brew ]; then BREW_BIN=\"/opt/homebrew/bin/brew\"; fi\n  if [ -z \"$BREW_BIN\" ] && [ -x /usr/local/bin/brew ]; then BREW_BIN=\"/usr/local/bin/brew\"; fi\nfi\nif [ -z \"$BREW_BIN\" ]; then echo \"Homebrew installation finished but brew was not found. Open a new Terminal and rerun this setup.\" >&2; exit 1; fi\neval \"$(\"$BREW_BIN\" shellenv)\"\nbrew list node >/dev/null 2>&1 || brew install node\nbrew list git >/dev/null 2>&1 || brew install git\nhash -r 2>/dev/null || true\nif ! npm install -g @openai/codex@0.142.2; then\n  echo \"Global npm install failed. Retrying with a user-owned npm prefix at $HOME/.npm-global.\"\n  mkdir -p \"$HOME/.npm-global\"\n  npm config set prefix \"$HOME/.npm-global\"\n  export PATH=\"$HOME/.npm-global/bin:$PATH\"\n  npm install -g @openai/codex@0.142.2\nfi\nexport PATH=\"$(npm config get prefix)/bin:$PATH\"\nhash -r 2>/dev/null || true\nappend_codexapi_path() {\n  profile=\"$1\"\n  mkdir -p \"$(dirname \"$profile\")\"\n  touch \"$profile\"\n  if ! grep -q \"# BEGIN CODEXAPI_PRO_NPM_PATH\" \"$profile\" 2>/dev/null; then\n    cat >> \"$profile\" <<'ENV'\n# BEGIN CODEXAPI_PRO_NPM_PATH\nexport PATH=\"$HOME/.npm-global/bin:/opt/homebrew/bin:/usr/local/bin:$PATH\"\n# END CODEXAPI_PRO_NPM_PATH\nENV\n  fi\n}\nappend_codexapi_path \"$HOME/.zshrc\"\nappend_codexapi_path \"$HOME/.zprofile\"\nappend_codexapi_path \"$HOME/.bashrc\"\nappend_codexapi_path \"$HOME/.profile\"\ncodex --version\nCODEX_HOME_DIR=\"$HOME/.codex\"\nCONFIG_PATH=\"$CODEX_HOME_DIR/config.toml\"\nmkdir -p \"$CODEX_HOME_DIR\" 2>/dev/null || true\nif [ -e \"$CODEX_HOME_DIR\" ] && [ ! -w \"$CODEX_HOME_DIR\" ]; then\n  echo \"Fixing ownership of $CODEX_HOME_DIR for this user...\"\n  if command -v sudo >/dev/null 2>&1; then sudo chown -R \"$(id -u):$(id -g)\" \"$CODEX_HOME_DIR\"; fi\nfi\nif [ -e \"$CONFIG_PATH\" ] && [ ! -w \"$CONFIG_PATH\" ]; then\n  echo \"Fixing ownership of $CONFIG_PATH for this user...\"\n  if command -v sudo >/dev/null 2>&1; then sudo chown \"$(id -u):$(id -g)\" \"$CONFIG_PATH\"; fi\nfi\nmkdir -p \"$CODEX_HOME_DIR\"\nif [ ! -w \"$CODEX_HOME_DIR\" ] || { [ -e \"$CONFIG_PATH\" ] && [ ! -w \"$CONFIG_PATH\" ]; }; then\n  echo \"Cannot write Codex config at $CONFIG_PATH. Run: sudo chown -R \\\"$(id -u):$(id -g)\\\" \\\"$CODEX_HOME_DIR\\\"\" >&2\n  exit 1\nfi\nrm -rf \"$CODEX_HOME_DIR/cache/codex_apps_tools\" 2>/dev/null || true\nCODEXAPI_BACKUP_TS=\"$(date +%Y%m%d%H%M%S)\"\nCODEXAPI_CONFIG_SNIPPET=\"$(mktemp)\"\ncat > \"$CODEXAPI_CONFIG_SNIPPET\" <<'TOML'\nmodel = \"gpt-5.5\"\nmodel_provider = \"codexapi\"\nmodel_reasoning_effort = \"high\"\napproval_policy = \"never\"\nsandbox_mode = \"danger-full-access\"\n\n[features]\napps = false\n\n[model_providers.codexapi]\nname = \"CodexAPI.pro\"\nbase_url = \"https://api-chicago.codexapi.pro/v1\"\nexperimental_bearer_token = \"<CODEXAPI_API_KEY>\"\nwire_api = \"responses\"\nsupports_websockets = false\nTOML\npython3 - \"$CONFIG_PATH\" \"$CODEXAPI_CONFIG_SNIPPET\" <<'PY'\nimport os, re, shutil, sys\nfrom pathlib import Path\n\npath = Path(sys.argv[1]).expanduser()\nsnippet = Path(sys.argv[2]).read_text()\npath.parent.mkdir(parents=True, exist_ok=True)\nif path.exists():\n    shutil.copy2(path, f\"{path}.backup.{os.environ.get('CODEXAPI_BACKUP_TS', 'manual')}\")\noriginal = path.read_text() if path.exists() else \"\"\ntop_keys = {\"model\", \"model_provider\", \"model_reasoning_effort\", \"approval_policy\", \"sandbox_mode\"}\nsection_re = re.compile(r\"^\\s*\\[[^\\]]+\\]\\s*$\")\nkey_re = re.compile(r\"^\\s*([A-Za-z0-9_-]+)\\s*=\")\nsnippet_lines = snippet.strip().splitlines()\nfirst_section = next((i for i, line in enumerate(snippet_lines) if section_re.match(line.strip())), len(snippet_lines))\ntop = snippet_lines[:first_section]\nprovider = []\nfeature_apps = 'apps = false'\ni = first_section\nwhile i < len(snippet_lines):\n    line = snippet_lines[i]\n    if re.match(r\"^\\[model_providers\\.codexapi\\]\\s*$\", line.strip()):\n        provider = snippet_lines[i:]\n        break\n    i += 1\nclean = []\nskip_codexapi = False\nin_section = False\nin_features = False\nfeatures_seen = False\nfor line in original.splitlines():\n    stripped = line.strip()\n    if re.match(r\"^\\[model_providers\\.codexapi\\]\\s*$\", stripped):\n        skip_codexapi = True\n        in_features = False\n        continue\n    if skip_codexapi and section_re.match(stripped):\n        skip_codexapi = False\n    if skip_codexapi:\n        continue\n    if section_re.match(stripped):\n        in_section = True\n        in_features = stripped == '[features]'\n        features_seen = features_seen or in_features\n    if not in_section:\n        m = key_re.match(line)\n        if m and m.group(1) in top_keys:\n            continue\n    if in_features:\n        m = key_re.match(line)\n        if m and m.group(1) == 'apps':\n            continue\n    clean.append(line)\nparts = []\nparts.extend(top)\nparts.append('')\ninserted_feature = False\nfor line in clean:\n    parts.append(line)\n    if line.strip() == '[features]':\n        parts.append(feature_apps)\n        inserted_feature = True\nif not features_seen:\n    if parts and parts[-1] != '':\n        parts.append('')\n    parts.extend(['[features]', feature_apps])\nif provider:\n    if parts and parts[-1] != '':\n        parts.append('')\n    parts.extend(provider)\npath.write_text('\\n'.join(line for line in parts if line is not None).rstrip() + '\\n')\nPY\nrm -f \"$CODEXAPI_CONFIG_SNIPPET\"\necho \"CodexAPI.pro is configured. Future macOS sessions can start with codex --search or codex resume --search.\"\ncodex --search",
  "futureStartCommand": "codex\ncodex --search",
  "startCommand": "set -e\nif ! command -v npm >/dev/null 2>&1; then\n  if command -v apt-get >/dev/null 2>&1; then\n    sudo apt-get update\n    sudo apt-get install -y ca-certificates curl gnupg\n    curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -\n    sudo apt-get install -y nodejs git\n  else\n    echo \"Install Node.js LTS and npm first, then rerun this block.\" >&2\n    exit 1\n  fi\nfi\nnpm install -g @openai/codex@0.142.2\nCODEX_HOME_DIR=\"$HOME/.codex\"\nCONFIG_PATH=\"$CODEX_HOME_DIR/config.toml\"\nmkdir -p \"$CODEX_HOME_DIR\" 2>/dev/null || true\nif [ -e \"$CODEX_HOME_DIR\" ] && [ ! -w \"$CODEX_HOME_DIR\" ]; then\n  echo \"Fixing ownership of $CODEX_HOME_DIR for this user...\"\n  if command -v sudo >/dev/null 2>&1; then sudo chown -R \"$(id -u):$(id -g)\" \"$CODEX_HOME_DIR\"; fi\nfi\nif [ -e \"$CONFIG_PATH\" ] && [ ! -w \"$CONFIG_PATH\" ]; then\n  echo \"Fixing ownership of $CONFIG_PATH for this user...\"\n  if command -v sudo >/dev/null 2>&1; then sudo chown \"$(id -u):$(id -g)\" \"$CONFIG_PATH\"; fi\nfi\nmkdir -p \"$CODEX_HOME_DIR\"\nif [ ! -w \"$CODEX_HOME_DIR\" ] || { [ -e \"$CONFIG_PATH\" ] && [ ! -w \"$CONFIG_PATH\" ]; }; then\n  echo \"Cannot write Codex config at $CONFIG_PATH. Run: sudo chown -R \\\"$(id -u):$(id -g)\\\" \\\"$CODEX_HOME_DIR\\\"\" >&2\n  exit 1\nfi\nrm -rf \"$CODEX_HOME_DIR/cache/codex_apps_tools\" 2>/dev/null || true\nCODEXAPI_BACKUP_TS=\"$(date +%Y%m%d%H%M%S)\"\nCODEXAPI_CONFIG_SNIPPET=\"$(mktemp)\"\ncat > \"$CODEXAPI_CONFIG_SNIPPET\" <<'TOML'\nmodel = \"gpt-5.5\"\nmodel_provider = \"codexapi\"\nmodel_reasoning_effort = \"high\"\napproval_policy = \"never\"\nsandbox_mode = \"danger-full-access\"\n\n[features]\napps = false\n\n[model_providers.codexapi]\nname = \"CodexAPI.pro\"\nbase_url = \"https://api-chicago.codexapi.pro/v1\"\nexperimental_bearer_token = \"<CODEXAPI_API_KEY>\"\nwire_api = \"responses\"\nsupports_websockets = false\nTOML\npython3 - \"$CONFIG_PATH\" \"$CODEXAPI_CONFIG_SNIPPET\" <<'PY'\nimport os, re, shutil, sys\nfrom pathlib import Path\n\npath = Path(sys.argv[1]).expanduser()\nsnippet = Path(sys.argv[2]).read_text()\npath.parent.mkdir(parents=True, exist_ok=True)\nif path.exists():\n    shutil.copy2(path, f\"{path}.backup.{os.environ.get('CODEXAPI_BACKUP_TS', 'manual')}\")\noriginal = path.read_text() if path.exists() else \"\"\ntop_keys = {\"model\", \"model_provider\", \"model_reasoning_effort\", \"approval_policy\", \"sandbox_mode\"}\nsection_re = re.compile(r\"^\\s*\\[[^\\]]+\\]\\s*$\")\nkey_re = re.compile(r\"^\\s*([A-Za-z0-9_-]+)\\s*=\")\nsnippet_lines = snippet.strip().splitlines()\nfirst_section = next((i for i, line in enumerate(snippet_lines) if section_re.match(line.strip())), len(snippet_lines))\ntop = snippet_lines[:first_section]\nprovider = []\nfeature_apps = 'apps = false'\ni = first_section\nwhile i < len(snippet_lines):\n    line = snippet_lines[i]\n    if re.match(r\"^\\[model_providers\\.codexapi\\]\\s*$\", line.strip()):\n        provider = snippet_lines[i:]\n        break\n    i += 1\nclean = []\nskip_codexapi = False\nin_section = False\nin_features = False\nfeatures_seen = False\nfor line in original.splitlines():\n    stripped = line.strip()\n    if re.match(r\"^\\[model_providers\\.codexapi\\]\\s*$\", stripped):\n        skip_codexapi = True\n        in_features = False\n        continue\n    if skip_codexapi and section_re.match(stripped):\n        skip_codexapi = False\n    if skip_codexapi:\n        continue\n    if section_re.match(stripped):\n        in_section = True\n        in_features = stripped == '[features]'\n        features_seen = features_seen or in_features\n    if not in_section:\n        m = key_re.match(line)\n        if m and m.group(1) in top_keys:\n            continue\n    if in_features:\n        m = key_re.match(line)\n        if m and m.group(1) == 'apps':\n            continue\n    clean.append(line)\nparts = []\nparts.extend(top)\nparts.append('')\ninserted_feature = False\nfor line in clean:\n    parts.append(line)\n    if line.strip() == '[features]':\n        parts.append(feature_apps)\n        inserted_feature = True\nif not features_seen:\n    if parts and parts[-1] != '':\n        parts.append('')\n    parts.extend(['[features]', feature_apps])\nif provider:\n    if parts and parts[-1] != '':\n        parts.append('')\n    parts.extend(provider)\npath.write_text('\\n'.join(line for line in parts if line is not None).rstrip() + '\\n')\nPY\nrm -f \"$CODEXAPI_CONFIG_SNIPPET\"\necho \"CodexAPI.pro is configured. Future sessions can start with codex or codex resume --search.\"\ncodex --search",
  "execSmokeTestCommand": "codex --search exec --skip-git-repo-check \"Say hello from CodexAPI.pro.\"",
  "loggedInOverrideCommand": "set -e\nif ! command -v npm >/dev/null 2>&1; then\n  if command -v apt-get >/dev/null 2>&1; then\n    sudo apt-get update\n    sudo apt-get install -y ca-certificates curl gnupg\n    curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -\n    sudo apt-get install -y nodejs git\n  else\n    echo \"Install Node.js LTS and npm first, then rerun this block.\" >&2\n    exit 1\n  fi\nfi\nnpm install -g @openai/codex@0.142.2\nCODEX_HOME_DIR=\"$HOME/.codex\"\nCONFIG_PATH=\"$CODEX_HOME_DIR/config.toml\"\nmkdir -p \"$CODEX_HOME_DIR\" 2>/dev/null || true\nif [ -e \"$CODEX_HOME_DIR\" ] && [ ! -w \"$CODEX_HOME_DIR\" ]; then\n  echo \"Fixing ownership of $CODEX_HOME_DIR for this user...\"\n  if command -v sudo >/dev/null 2>&1; then sudo chown -R \"$(id -u):$(id -g)\" \"$CODEX_HOME_DIR\"; fi\nfi\nif [ -e \"$CONFIG_PATH\" ] && [ ! -w \"$CONFIG_PATH\" ]; then\n  echo \"Fixing ownership of $CONFIG_PATH for this user...\"\n  if command -v sudo >/dev/null 2>&1; then sudo chown \"$(id -u):$(id -g)\" \"$CONFIG_PATH\"; fi\nfi\nmkdir -p \"$CODEX_HOME_DIR\"\nif [ ! -w \"$CODEX_HOME_DIR\" ] || { [ -e \"$CONFIG_PATH\" ] && [ ! -w \"$CONFIG_PATH\" ]; }; then\n  echo \"Cannot write Codex config at $CONFIG_PATH. Run: sudo chown -R \\\"$(id -u):$(id -g)\\\" \\\"$CODEX_HOME_DIR\\\"\" >&2\n  exit 1\nfi\nrm -rf \"$CODEX_HOME_DIR/cache/codex_apps_tools\" 2>/dev/null || true\nCODEXAPI_BACKUP_TS=\"$(date +%Y%m%d%H%M%S)\"\nCODEXAPI_CONFIG_SNIPPET=\"$(mktemp)\"\ncat > \"$CODEXAPI_CONFIG_SNIPPET\" <<'TOML'\nmodel = \"gpt-5.5\"\nmodel_provider = \"codexapi\"\nmodel_reasoning_effort = \"high\"\napproval_policy = \"never\"\nsandbox_mode = \"danger-full-access\"\n\n[features]\napps = false\n\n[model_providers.codexapi]\nname = \"CodexAPI.pro\"\nbase_url = \"https://api-chicago.codexapi.pro/v1\"\nexperimental_bearer_token = \"<CODEXAPI_API_KEY>\"\nwire_api = \"responses\"\nsupports_websockets = false\nTOML\npython3 - \"$CONFIG_PATH\" \"$CODEXAPI_CONFIG_SNIPPET\" <<'PY'\nimport os, re, shutil, sys\nfrom pathlib import Path\n\npath = Path(sys.argv[1]).expanduser()\nsnippet = Path(sys.argv[2]).read_text()\npath.parent.mkdir(parents=True, exist_ok=True)\nif path.exists():\n    shutil.copy2(path, f\"{path}.backup.{os.environ.get('CODEXAPI_BACKUP_TS', 'manual')}\")\noriginal = path.read_text() if path.exists() else \"\"\ntop_keys = {\"model\", \"model_provider\", \"model_reasoning_effort\", \"approval_policy\", \"sandbox_mode\"}\nsection_re = re.compile(r\"^\\s*\\[[^\\]]+\\]\\s*$\")\nkey_re = re.compile(r\"^\\s*([A-Za-z0-9_-]+)\\s*=\")\nsnippet_lines = snippet.strip().splitlines()\nfirst_section = next((i for i, line in enumerate(snippet_lines) if section_re.match(line.strip())), len(snippet_lines))\ntop = snippet_lines[:first_section]\nprovider = []\nfeature_apps = 'apps = false'\ni = first_section\nwhile i < len(snippet_lines):\n    line = snippet_lines[i]\n    if re.match(r\"^\\[model_providers\\.codexapi\\]\\s*$\", line.strip()):\n        provider = snippet_lines[i:]\n        break\n    i += 1\nclean = []\nskip_codexapi = False\nin_section = False\nin_features = False\nfeatures_seen = False\nfor line in original.splitlines():\n    stripped = line.strip()\n    if re.match(r\"^\\[model_providers\\.codexapi\\]\\s*$\", stripped):\n        skip_codexapi = True\n        in_features = False\n        continue\n    if skip_codexapi and section_re.match(stripped):\n        skip_codexapi = False\n    if skip_codexapi:\n        continue\n    if section_re.match(stripped):\n        in_section = True\n        in_features = stripped == '[features]'\n        features_seen = features_seen or in_features\n    if not in_section:\n        m = key_re.match(line)\n        if m and m.group(1) in top_keys:\n            continue\n    if in_features:\n        m = key_re.match(line)\n        if m and m.group(1) == 'apps':\n            continue\n    clean.append(line)\nparts = []\nparts.extend(top)\nparts.append('')\ninserted_feature = False\nfor line in clean:\n    parts.append(line)\n    if line.strip() == '[features]':\n        parts.append(feature_apps)\n        inserted_feature = True\nif not features_seen:\n    if parts and parts[-1] != '':\n        parts.append('')\n    parts.extend(['[features]', feature_apps])\nif provider:\n    if parts and parts[-1] != '':\n        parts.append('')\n    parts.extend(provider)\npath.write_text('\\n'.join(line for line in parts if line is not None).rstrip() + '\\n')\nPY\nrm -f \"$CODEXAPI_CONFIG_SNIPPET\"\necho \"CodexAPI.pro is configured. Future sessions can start with codex or codex resume --search.\"\ncodex --search",
  "loggedInOverrideExecSmokeTestCommand": "codex --search exec --skip-git-repo-check \"Say hello from CodexAPI.pro.\"",
  "resumeLastCommand": "codex resume --search\ncodex resume --last --search",
  "windowsDependencyInstallCommand": "# Run PowerShell as Administrator for this dependency step.\nwinget source update\nwinget install --id OpenJS.NodeJS.LTS -e --accept-package-agreements --accept-source-agreements\nwinget install --id Git.Git -e --accept-package-agreements --accept-source-agreements\nSet-ExecutionPolicy -Scope CurrentUser RemoteSigned -Force\n# Close PowerShell, open a new PowerShell window, then run the verification step.",
  "windowsVerifyDependenciesCommand": "node --version\nnpm --version\ngit --version",
  "windowsCodexInstallCommand": "npm install -g @openai/codex@0.142.2\ncodex --version",
  "windowsFullInstallCommand": "# Run PowerShell as Administrator for this dependency step.\nwinget source update\nwinget install --id OpenJS.NodeJS.LTS -e --accept-package-agreements --accept-source-agreements\nwinget install --id Git.Git -e --accept-package-agreements --accept-source-agreements\nSet-ExecutionPolicy -Scope CurrentUser RemoteSigned -Force\n# Close PowerShell, open a new PowerShell window, then run the verification step.\n\n# After reopening PowerShell:\nnode --version\nnpm --version\ngit --version\nnpm install -g @openai/codex@0.142.2\ncodex --version",
  "windowsSetupAndStartCommand": "$ErrorActionPreference = \"Stop\"\nwinget source update\nif (-not (Get-Command node -ErrorAction SilentlyContinue)) { winget install --id OpenJS.NodeJS.LTS -e --accept-package-agreements --accept-source-agreements }\nif (-not (Get-Command git -ErrorAction SilentlyContinue)) { winget install --id Git.Git -e --accept-package-agreements --accept-source-agreements }\nnpm install -g @openai/codex@0.142.2\n$CodexHome = \"$env:USERPROFILE\\.codex\"\n$ConfigPath = Join-Path $CodexHome \"config.toml\"\nNew-Item -ItemType Directory -Force -Path $CodexHome | Out-Null\n$ConfigProbe = Join-Path $CodexHome \".codexapi-write-test\"\ntry {\n  \"ok\" | Set-Content -Path $ConfigProbe -Encoding utf8 -Force\n  Remove-Item $ConfigProbe -Force\n} catch {\n  Write-Error \"Cannot write to $CodexHome. Open PowerShell as your normal Windows user, or fix folder ownership if this .codex folder was created by an Administrator shell.\"\n  throw\n}\nif (Test-Path $ConfigPath) {\n  Copy-Item $ConfigPath \"$ConfigPath.backup.$((Get-Date).ToString('yyyyMMddHHmmss'))\" -Force\n}\n$CodexAppsCache = Join-Path $CodexHome \"cache\\codex_apps_tools\"\nRemove-Item -Recurse -Force -ErrorAction SilentlyContinue $CodexAppsCache\n$CodexApiBackupStamp = (Get-Date).ToString('yyyyMMddHHmmss')\n$CodexApiConfigSnippet = @'\nmodel = \"gpt-5.5\"\nmodel_provider = \"codexapi\"\nmodel_reasoning_effort = \"high\"\napproval_policy = \"never\"\nsandbox_mode = \"danger-full-access\"\n\n[features]\napps = false\n\n[model_providers.codexapi]\nname = \"CodexAPI.pro\"\nbase_url = \"https://api-chicago.codexapi.pro/v1\"\nexperimental_bearer_token = \"<CODEXAPI_API_KEY>\"\nwire_api = \"responses\"\nsupports_websockets = false\n'@\nif (Test-Path $ConfigPath) { Copy-Item $ConfigPath \"$ConfigPath.backup.$CodexApiBackupStamp\" -Force }\n$ExistingConfig = if (Test-Path $ConfigPath) { Get-Content $ConfigPath -Raw } else { \"\" }\n$Lines = @()\n$SkipCodexApi = $false\n$InSection = $false\n$InFeatures = $false\n$FeaturesSeen = $false\nforeach ($Line in ($ExistingConfig -split \"`r?`n\")) {\n  $Trimmed = $Line.Trim()\n  if ($Trimmed -match '^\\[model_providers\\.codexapi\\]\\s*$') { $SkipCodexApi = $true; $InFeatures = $false; continue }\n  if ($SkipCodexApi -and $Trimmed -match '^\\[[^\\]]+\\]\\s*$') { $SkipCodexApi = $false }\n  if ($SkipCodexApi) { continue }\n  if ($Trimmed -match '^\\[[^\\]]+\\]\\s*$') { $InSection = $true; $InFeatures = ($Trimmed -eq '[features]'); if ($InFeatures) { $FeaturesSeen = $true } }\n  if (-not $InSection -and $Trimmed -match '^(model|model_provider|model_reasoning_effort|approval_policy|sandbox_mode)\\s*=') { continue }\n  if ($InFeatures -and $Trimmed -match '^apps\\s*=') { continue }\n  if ($Line.Trim().Length -gt 0) { $Lines += $Line }\n}\n$SnippetLines = $CodexApiConfigSnippet.Trim() -split \"`r?`n\"\n$FirstSection = $SnippetLines.Count\nfor ($i = 0; $i -lt $SnippetLines.Count; $i++) { if ($SnippetLines[$i].Trim() -match \"^\\[[^\\]]+\\]\\s*$\") { $FirstSection = $i; break } }\n$Top = @($SnippetLines[0..($FirstSection - 1)]) | Where-Object { $_ -ne $null }\n$ProviderStart = -1\nfor ($i = 0; $i -lt $SnippetLines.Count; $i++) { if ($SnippetLines[$i].Trim() -match \"^\\[model_providers\\.codexapi\\]\\s*$\") { $ProviderStart = $i; break } }\n$Provider = if ($ProviderStart -ge 0) { @($SnippetLines[$ProviderStart..($SnippetLines.Count - 1)]) } else { @() }\n$Out = @()\n$Out += $Top\n$Out += ''\n$InsertedFeatures = $false\nforeach ($Line in $Lines) { $Out += $Line; if ($Line.Trim() -eq '[features]') { $Out += 'apps = false'; $InsertedFeatures = $true } }\nif (-not $FeaturesSeen) { $Out += ''; $Out += '[features]'; $Out += 'apps = false' }\n$Out += ''\n$Out += $Provider\n($Out -join \"`n\").Trim() + \"`n\" | Set-Content -Path $ConfigPath -Encoding UTF8\nWrite-Host \"CodexAPI.pro is configured. Future sessions can start with codex or codex resume --search.\"\ncodex --search",
  "windowsSetupCommand": "$ErrorActionPreference = \"Stop\"\nwinget source update\nif (-not (Get-Command node -ErrorAction SilentlyContinue)) { winget install --id OpenJS.NodeJS.LTS -e --accept-package-agreements --accept-source-agreements }\nif (-not (Get-Command git -ErrorAction SilentlyContinue)) { winget install --id Git.Git -e --accept-package-agreements --accept-source-agreements }\nnpm install -g @openai/codex@0.142.2\n$CodexHome = \"$env:USERPROFILE\\.codex\"\n$ConfigPath = Join-Path $CodexHome \"config.toml\"\nNew-Item -ItemType Directory -Force -Path $CodexHome | Out-Null\n$ConfigProbe = Join-Path $CodexHome \".codexapi-write-test\"\ntry {\n  \"ok\" | Set-Content -Path $ConfigProbe -Encoding utf8 -Force\n  Remove-Item $ConfigProbe -Force\n} catch {\n  Write-Error \"Cannot write to $CodexHome. Open PowerShell as your normal Windows user, or fix folder ownership if this .codex folder was created by an Administrator shell.\"\n  throw\n}\nif (Test-Path $ConfigPath) {\n  Copy-Item $ConfigPath \"$ConfigPath.backup.$((Get-Date).ToString('yyyyMMddHHmmss'))\" -Force\n}\n$CodexAppsCache = Join-Path $CodexHome \"cache\\codex_apps_tools\"\nRemove-Item -Recurse -Force -ErrorAction SilentlyContinue $CodexAppsCache\n$CodexApiBackupStamp = (Get-Date).ToString('yyyyMMddHHmmss')\n$CodexApiConfigSnippet = @'\nmodel = \"gpt-5.5\"\nmodel_provider = \"codexapi\"\nmodel_reasoning_effort = \"high\"\napproval_policy = \"never\"\nsandbox_mode = \"danger-full-access\"\n\n[features]\napps = false\n\n[model_providers.codexapi]\nname = \"CodexAPI.pro\"\nbase_url = \"https://api-chicago.codexapi.pro/v1\"\nexperimental_bearer_token = \"<CODEXAPI_API_KEY>\"\nwire_api = \"responses\"\nsupports_websockets = false\n'@\nif (Test-Path $ConfigPath) { Copy-Item $ConfigPath \"$ConfigPath.backup.$CodexApiBackupStamp\" -Force }\n$ExistingConfig = if (Test-Path $ConfigPath) { Get-Content $ConfigPath -Raw } else { \"\" }\n$Lines = @()\n$SkipCodexApi = $false\n$InSection = $false\n$InFeatures = $false\n$FeaturesSeen = $false\nforeach ($Line in ($ExistingConfig -split \"`r?`n\")) {\n  $Trimmed = $Line.Trim()\n  if ($Trimmed -match '^\\[model_providers\\.codexapi\\]\\s*$') { $SkipCodexApi = $true; $InFeatures = $false; continue }\n  if ($SkipCodexApi -and $Trimmed -match '^\\[[^\\]]+\\]\\s*$') { $SkipCodexApi = $false }\n  if ($SkipCodexApi) { continue }\n  if ($Trimmed -match '^\\[[^\\]]+\\]\\s*$') { $InSection = $true; $InFeatures = ($Trimmed -eq '[features]'); if ($InFeatures) { $FeaturesSeen = $true } }\n  if (-not $InSection -and $Trimmed -match '^(model|model_provider|model_reasoning_effort|approval_policy|sandbox_mode)\\s*=') { continue }\n  if ($InFeatures -and $Trimmed -match '^apps\\s*=') { continue }\n  if ($Line.Trim().Length -gt 0) { $Lines += $Line }\n}\n$SnippetLines = $CodexApiConfigSnippet.Trim() -split \"`r?`n\"\n$FirstSection = $SnippetLines.Count\nfor ($i = 0; $i -lt $SnippetLines.Count; $i++) { if ($SnippetLines[$i].Trim() -match \"^\\[[^\\]]+\\]\\s*$\") { $FirstSection = $i; break } }\n$Top = @($SnippetLines[0..($FirstSection - 1)]) | Where-Object { $_ -ne $null }\n$ProviderStart = -1\nfor ($i = 0; $i -lt $SnippetLines.Count; $i++) { if ($SnippetLines[$i].Trim() -match \"^\\[model_providers\\.codexapi\\]\\s*$\") { $ProviderStart = $i; break } }\n$Provider = if ($ProviderStart -ge 0) { @($SnippetLines[$ProviderStart..($SnippetLines.Count - 1)]) } else { @() }\n$Out = @()\n$Out += $Top\n$Out += ''\n$InsertedFeatures = $false\nforeach ($Line in $Lines) { $Out += $Line; if ($Line.Trim() -eq '[features]') { $Out += 'apps = false'; $InsertedFeatures = $true } }\nif (-not $FeaturesSeen) { $Out += ''; $Out += '[features]'; $Out += 'apps = false' }\n$Out += ''\n$Out += $Provider\n($Out -join \"`n\").Trim() + \"`n\" | Set-Content -Path $ConfigPath -Encoding UTF8\nWrite-Host \"CodexAPI.pro is configured. Future sessions can start with codex or codex resume --search.\"\ncodex --search",
  "windowsStartCommand": "codex\ncodex --search",
  "windowsResumeLastCommand": "codex resume --search\ncodex resume --last --search",
  "windowsExecSmokeTestCommand": "codex --search exec --skip-git-repo-check \"Say hello from CodexAPI.pro.\"",
  "macosStartCommand": "codex\ncodex --search",
  "macosResumeLastCommand": "codex resume --search\ncodex resume --last --search",
  "macosExecSmokeTestCommand": "codex --search exec --skip-git-repo-check \"Say hello from CodexAPI.pro.\"",
  "configToml": "model = \"gpt-5.5\"\nmodel_provider = \"codexapi\"\nmodel_reasoning_effort = \"high\"\napproval_policy = \"never\"\nsandbox_mode = \"danger-full-access\"\n\n[features]\napps = false\n\n[model_providers.codexapi]\nname = \"CodexAPI.pro\"\nbase_url = \"https://api-chicago.codexapi.pro/v1\"\nenv_key = \"CODEXAPI_CODEX_API_KEY\"\nwire_api = \"responses\"\nsupports_websockets = false\n",
  "clientModelLabel": "Deepseek v4 Budget",
  "displayModel": "Deepseek v4 Budget",
  "modelDisplayName": "Deepseek v4 Budget"
}

Windows users must use PowerShell syntax, not Bash exports. The live /api/v1/cli/public-codex payload includes a complete PowerShell setup block that installs dependencies when needed, writes %USERPROFILE%\.codex\config.toml, saves the wallet username as the provider bearer token, and starts codex --search.

Resume, Isolation, and Approvals

Each managed project_id maps to one stable workspace directory. When the same user returns to that project, the API resumes the latest Codex thread for that workspace instead of creating a fresh conversation.

Project-scoped approval handling stays explicit:

• GET /api/v1/projects/{project_id}/approvals lists pending approval requests for the project’s latest thread.
• POST /api/v1/projects/{project_id}/approvals/{request_id}/resolve resolves the approval. An empty JSON body now defaults to {"decision":"accept"} for the current command and file-change approval flows.
• POST /api/v1/projects/{project_id}/turns/{turn_id}/interrupt interrupts a running turn.