Codex Usage Guide

🚀 Great News! We now support Codex transit service! Through cometapi, you can seamlessly access OpenAI's powerful code generation models (like GPT-5) without worrying about regional restrictions or complex configurations. Whether you're a developer or an AI enthusiast, you can easily launch your programming assistant. Try it now and boost your coding efficiency! (Register on cometapi to get your API key: https://cometapi.com)

💡 Preparations

Before starting, ensure your environment meets the following requirements:

Operating System: Windows 10/11, macOS 10.15+, Ubuntu 20.04+ or Debian 10+

Node.js: Version 18 or higher (if installing via npm)

1️⃣ Install Node.js (Skip if Already Installed)

Note: Ensure your Node.js version is ≥ 18.0

Windows Users

Ubuntu / Debian Users

macOS Users

2️⃣ Install Codex

Choose an installation method:

3️⃣ Configure Codex

cometapi acts as a transit proxy, providing simple configuration. Create a configuration file to connect to our service.

Step One: Create Configuration Folder

Step Two: Create config.toml File

Add the following content to ~/.codex/config.toml (replace sk-xxx with your cometapi key):

model_provider = "cometapi"
model = "gpt-5"
model_reasoning_effort = "high"
disable_response_storage = true

[model_providers.cometapi]
name = "cometapi"
base_url = "https://api.cometapi.com/v1"
wire_api = "responses"
env_key = "sk-xxx"

Step Three: Create auth.json File

Add the following content to ~/.codex/auth.json (replace sk-xxx with your cometapi key):

{
  "OPENAI_API_KEY": "sk-xxx"
}

4️⃣ Get Started

After configuration, navigate to your project directory and start Codex:

On first run, complete the initialization as prompted (such as theme selection and security confirmation). Now, you can interact with your AI programming partner, generate code, debug, and more! 🚀

Tip: For permanent environment variable support, refer to the OpenAI official documentation or add export commands to your shell configuration file.

❓ FAQ

Important Note: cometapi serves only as a transit proxy for the official Codex, supporting standard API requests. If you encounter issues, first check your key and network.

Q: What if installation fails?
A: Ensure Node.js or Homebrew is installed correctly. Check npm/brew permissions.

Q: API errors or connection failures?
A: This could be due to unstable network or invalid key. Restart Codex and retry; verify the keys in config.toml and auth.json.

Q: Why use the "gpt-5" model?
A: This is an example of an advanced model supported by cometapi. Currently, only gpt-5 is supported.

Q: How to get a key?
A: Register on cometapi and generate a token starting with sk-. Set the quota to unlimited to avoid restrictions.

Q: Status shows offline or fetch failed?
A: This may be due to local network issues. Try using a proxy tool to connect to international networks, or check Google connectivity (Codex will test it).

For more help, contact cometapi support! Enjoy your efficient coding journey. 🌟

💡 Preparations#

1️⃣ Install Node.js (Skip if Already Installed)#

Windows Users#

Ubuntu / Debian Users#

macOS Users#

2️⃣ Install Codex#

3️⃣ Configure Codex#

Step One: Create Configuration Folder#

Step Two: Create config.toml File#

Step Three: Create auth.json File#

4️⃣ Get Started#

❓ FAQ#