Skip to content

# OpenAI

OpenAI provides developer APIs for GPT models. Codex supports ChatGPT sign-in for subscription access or API key sign-in for usage-based access. Codex cloud requires ChatGPT sign-in.

# Option A: OpenAI API key (OpenAI Platform)

Best for: direct API access and usage-based billing. Get your API key from the OpenAI dashboard.

# CLI setup

bash
opensoul onboard --auth-choice openai-api-key
# or non-interactive
opensoul onboard --openai-api-key "$OPENAI_API_KEY"

# Config snippet

json5
{
  env: { OPENAI_API_KEY: "sk-..." },
  agents: { defaults: { model: { primary: "openai/gpt-5.1-codex" } } },
}

# Option B: OpenAI Code (Codex) subscription

Best for: using ChatGPT/Codex subscription access instead of an API key. Codex cloud requires ChatGPT sign-in, while the Codex CLI supports ChatGPT or API key sign-in.

# CLI setup (Codex OAuth)

bash
# Run Codex OAuth in the wizard
opensoul onboard --auth-choice openai-codex

# Or run OAuth directly
opensoul models auth login --provider openai-codex

# Config snippet (Codex subscription)

json5
{
  agents: { defaults: { model: { primary: "openai-codex/gpt-5.3-codex" } } },
}

# Notes

Released under the MIT License.