概要
~/.codex/(config.toml と auth.json)の 同じ設定 を共有します。
APIYI との連携は、ひと言で言えば次のとおりです。
OpenAI の endpoint を APIYI に置き換えるAPIYI は OpenAI互換インターフェース(透過プロキシ) です。1回設定すれば、デスクトップアプリ、拡張機能、ターミナルのすべてで動作します。
🔁 1つの設定、3つの利用面
~/.codex/を共有します — 1回設定するだけです⚡ 最新モデル
gpt-5.6-sol / gpt-5.5 / grok-4.5 に対応し、ほかのモデルも利用できます💰 従量課金
🪟 クロスプラットフォーム
~/.codex/config.toml で「モデルプロバイダ」を APIYI に設定し、~/.codex/auth.json に Key を入れることです。デスクトップアプリと IDE 拡張機能の両方がこれらのファイルに依存します。そのため、このガイドでは環境変数ではなく設定ファイルを先に説明します。1. 前提条件: APIYIキーを取得する
APIYIにサインアップ / ログインする
API Keyを作成する
キーをコピーする
sk-***)をコピーし、安全に保管してください。設定ファイルに貼り付けます。使用する画面を選ぶ
3つの画面はすべてまったく同じ設定を使います。ワークフローに合うものを選んでください。🖥️ デスクトップアプリ
🧩 IDE拡張機能
⌨️ CLI
2. コア設定(推奨: 設定ファイル、環境変数ではありません)
以下の3つの方法があります — 1つだけ選んでください。推奨順は、設定ファイルを手書きする(最も信頼性が高い)→ ビジュアル設定 → 環境変数 です。オプション 1 · auth.json + config.toml を手動で記述(推奨、最も信頼性が高い)
Codex の設定ディレクトリを開き(なければ作成し)、その中に2つのファイルを追加/編集します。
- 🪟 Windows
- Mac / Linux
%USERPROFILE%\.codex\(つまり C:\Users\YourName\.codex\ です)。ファイル エクスプローラーで開いてください。auth.json — ここにキーを入れてください:
config.toml — モデル プロバイダを APIYI に向ける:
新規ファイル なら、下の内容をそのまま貼り付けてください。既存ファイル なら、「global keys」を最上部に追加し、[model_providers.apiyi] ブロックを最下部に追加してください(理由は下のヒントを参照)。
既存の config.toml を安全に編集する方法(バックアップ + マージのベストプラクティス)
既存の config.toml を安全に編集する方法(バックアップ + マージのベストプラクティス)
model / model_provider / preferred_auth_method の行は最上部に入れ、[model_providers.apiyi] ブロックは最下部に追加します。それ以外はそのままにしてください。ステップ 3: メインの設定を触らずに試したいだけですか? プロファイルを使ってください。上の内容で ~/.codex/apiyi.config.toml を作成し、次に codex --profile apiyi を実行します — 完全に分離されています(Advanced を参照)。base_url: 常にhttps://api.apiyi.com/v1です — そこには/v1が必須 で、ないと 404 になります。experimental_bearer_token: キーをプロバイダ ブロックに直接入れ、Bearer token として送信します。これは、デスクトップアプリ、IDE 拡張機能、CLI のすべてで確実に動作する唯一の形式です — 環境変数は使いません。- プロバイダの認証フィールドは排他的です。1つだけ選んでください:
experimental_bearer_token(キーを設定ファイルに入れる、推奨) /env_key(起動したプロセスの環境変数 からキーを読み取る — なお、auth.jsonにフォールバックしない点に注意してください。また、デスクトップアプリはターミナルで export した変数を参照できません) /requires_openai_auth(auth.jsonの公式ログイン状態を再利用する)。このガイドの古い版でenv_key+requires_openai_authを組み合わせていた場合は、現在の形式に切り替えてください。 wire_api = "responses": Codex のデフォルトかつ推奨のプロトコルで、APIYI がサポートしています。特定のモデルが 404 / unknown endpoint を返す場合は、フォールバックとして"chat"に切り替えてください(Advanced を参照)。- このファイルに
C:\Users\xxx\.codex\...のような絶対パスをハードコードしないでください — マシン間で壊れます。
オプション 2 · cc-switch のビジュアル設定(GUI、手動編集なし)
手でファイルを編集したくない場合は、CC Switch を使ってください。数回クリックするだけで、APIYI の URL、Key、モデルを Codex の設定に書き込みます。Claude Code、Codex、Gemini CLI なども1か所で管理でき、ワンクリックで切り替えられます。上記のバックアップ/マージも自動でやってくれるので、初心者にはまずおすすめです。 CC Switch ビジュアル設定 を参照してください。設定後は、Codex のデスクトップアプリ / 拡張機能 / CLI が自動的に設定を読み込みます。オプション 3 · 環境変数(任意、少し面倒、推奨しません)
すぐにターミナルでテストしたいだけですか? 環境変数方式を展開してください(長期利用には不向きです)
すぐにターミナルでテストしたいだけですか? 環境変数方式を展開してください(長期利用には不向きです)
OPENAI_BASE_URL / OPENAI_API_KEY の環境変数も読み取れます:3. 各画面の使い方(デスクトップ優先)
~/.codex/ をセットアップしたら、以下のいずれかの画面を選んでください。設定を変更したらプログラムを再起動してください(Codex は起動時にのみ設定を読み込みます)。
1. Codex デスクトップアプリ(最もおすすめ)
- Codex デスクトップアプリをインストールして開きます。
- 初回起動時に認証方法を選びます。apikey を選択してください(ChatGPT のログインではありません)。
- モデル / プロバイダー選択で、
apiyiプロバイダーと対象モデル(例:gpt-5.4)を選択します。 - 反映するためにアプリを再起動します。
- 最小限のタスクを実行して確認します(4章 を参照)。
2. IDE 拡張機能(VSCode / Cursor)
- 拡張機能マーケットプレイスを開き(VSCode では
Ctrl+Shift+X/Cmd+Shift+Xを押します)、Codex — OpenAI's coding agentを検索してInstallをクリックします。 - インストール後、サイドバーに Codex アイコンが表示されるので、クリックしてパネルを開きます。
- 初回オープン時に 3 つのプロンプトに答えます。① 認証方法 — apikey を選択; ② キーの取得元 — 「設定ファイル / 環境変数」を選択; ③
AGENTS.mdを有効にする(推奨)。 - 反映するためにエディターを再起動します。
- Codex パネルで最小限のタスクを実行して確認します。
3. CLI
公式 CLI をグローバルにインストールします(Node.js 18+ が必要です):4. 最小限の確認
設定して再起動した後、任意の画面で最小限のタスクを入力してください:5. Models (APIYI Recommendations)
これらをconfig.toml の model フィールドに設定するか、実行時に切り替えます:
/v1/responses プロトコル対応を備えた珍しい非 OpenAI モデルです。Codex では wire_api = "responses" をそのままにして、model を grok-4.5 に切り替えるだけで使えます。Codex のエージェント機能(tool calls、reasoning items など)はすべてネイティブプロトコル上で動作します。responses エンドポイントは APIYI で grok-4.5 により検証済みです。その他の Grok モデルも同じアーキテクチャを共有しており、同様に動作すると期待されています。404 を返す場合は、Section 6 のフォールバックを使ってください。Grok API Guide もご覧ください。Claude / Gemini と比較すると: APIYI ではこの 2 つはOpenAI 互換のチャットモードでのみ動作し、responses エンドポイントはありません。そのため、Codex では wire_api = "chat" にフォールバックする必要があります。Codex のエージェントシナリオは responses プロトコルを前提に設計されているため、チャットモードでは tool calling の不整合や体験の低下が発生することがあります。Claude / Gemini でコーディングする場合は、代わりにそれぞれのネイティブツール(Claude Code / Gemini CLI)を使ってください。glm-5.2 です。config.toml の model フィールドを、対象のモデル ID に変更するだけです(または実行時に -m)。4 Ways to Switch Models
① 起動時に指定(CLI):/model と入力し、プロンプトに従ってください。
④ 既定モデルを設定する(永続的): ~/.codex/config.toml を編集し、model を変更して保存し、再起動します:
6. 詳細設定
カスタムシステムプロンプト(instructions.md)
カスタムシステムプロンプト(instructions.md)
~/.codex/instructions.md を編集して、コーディングスタイル、出力言語、プロジェクトの規約を定義します。例:プロジェクトレベルの AGENTS.md
プロジェクトレベルの AGENTS.md
codex /init を実行して、構成と規約を記録する AGENTS.md を生成します。Codex が既定で特定の言語で応答するようにするには、次を追加します:フォールバックのプロトコル: wire_api を chat に切り替える
フォールバックのプロトコル: wire_api を chat に切り替える
wire_api = "responses" は Codex のデフォルトかつ推奨プロトコルで、ほとんどのモデルはそのまま動作します。モデルが 404 / unknown endpoint を返す場合は、そのプロバイダの wire_api を "chat" に変更し(/chat/completions を使用します)、再試行してください。複数の設定(プロファイル)
複数の設定(プロファイル)
<name>.config.toml を ~/.codex/ の下に作成し(たとえば、公式セットアップでは openai.config.toml を使用します)、その後は実行時に codex --profile <name> で切り替えます。APIYI と他のプロバイダを行き来するのに便利です。よく使うフラグ
よく使うフラグ
7. トラブルシューティング
1. 環境変数が見つからない: OPENAI_API_KEY(デスクトップアプリ / 拡張機能で最もよくある)
1. 環境変数が見つからない: OPENAI_API_KEY(デスクトップアプリ / 拡張機能で最もよくある)
auth.json + config.toml を正しく設定してアプリを再起動したのに、それでも Missing environment variable: OPENAI_API_KEY と表示される場合、原因はプロバイダーブロック内の env_key = "OPENAI_API_KEY" です(このガイドの古い版で使われていた形式です)。env_key は、Codex を起動したプロセスの環境変数から Key を読み取る ことを意味します。auth.json にフォールバックすることは ありません(こちらは OpenAI の公式ログイン状態にのみ使われます)。また、デスクトップアプリ / IDE を Dock やランチャーから起動した場合、ターミナルで export した変数は継承されません(export の .zshrc は GUI アプリには影響しません)ので、何度再起動しても変数は表示されません。修正方法(推奨): ~/.codex/config.toml を編集し、プロバイダーブロックから env_key を削除し(requires_openai_auth があればそれも削除し)、Key を設定ファイルに直接記述します:env_key を使いたい場合): 変数をシステム全体で設定します。macOS では launchctl setenv OPENAI_API_KEY "sk-your-key" を実行してからアプリを再起動してください(再起動後は再実行が必要です)。Windows では setx OPENAI_API_KEY "sk-your-key" を実行してからアプリを再起動してください。CLI のみで使う場合は、シェルプロファイルに export を入れれば十分です。2. auth.json / config.toml のパスと内容を確認する
2. auth.json / config.toml のパスと内容を確認する
auth.jsonは有効な JSON である必要があり、OPENAI_API_KEYには実際のsk-Key が設定されていなければなりません。config.tomlは有効な TOML として解釈できる必要があります(引用符とインデントに注意してください)。- パス: Windows は
%USERPROFILE%\.codex\、Mac/Linux は~/.codex/です。
3. Key が有効で、利用可能なクレジットがあることを確認する
3. Key が有効で、利用可能なクレジットがあることを確認する
4. base_url に /v1 が含まれていることを確認する
4. base_url に /v1 が含まれていることを確認する
/v1 がないことです。正しい例: https://api.apiyi.com/v1。その後、ローカルプロキシと DNS を確認してください。5. 設定変更のたびに再起動する
5. 設定変更のたびに再起動する
auth.json / config.toml を編集した後は、必ずプログラムを再起動してください。6. まだ不安定な場合: wire_api を chat に切り替える
6. まだ不安定な場合: wire_api を chat に切り替える
responses プロトコルと互換性がない場合は、そのプロバイダーの wire_api を "chat" に変更して再試行してください。8. よくある質問
なぜ Codex は APIYI で動作するのですか?
なぜ Codex は APIYI で動作するのですか?
https://api.apiyi.com/v1 と https://api.openai.com/v1 は、リクエスト/レスポンス形式で互換に使えます。Base URL を差し替えるだけで十分です。なぜ、単純な hello で数万の input token を消費するのですか?
なぜ、単純な hello で数万の input token を消費するのですか?
AGENTS.md、関連ソース)、それらを prompt と一緒にコンテキストとして送信します。そのため、1語だけの hello でも数千の input token がかかることがあります。どう減らしますか?- 最小限のタスクは 空のディレクトリ か 非常に小さなプロジェクト で試し、コンテキストを小さく保ってください。
- 具体的で小さなタスクを指定し、対象ファイルを正確に名前で挙げてください(たとえば「
app.pyだけを見て、hello エンドポイントを追加して」)と伝えることで、Codex がスキャンする範囲を絞れます。 - こうした使い捨ての確認には、より安価なモデル(例:
gpt-5.4-mini)を使ってください。
`command not found: codex`
`command not found: codex`
npm bin -g があなたの PATH にあるか確認してください。無効な API Key (401 / Invalid Key)
無効な API Key (401 / Invalid Key)
- OpenAI key ではなく、
sk-で始まる APIYI Key を使用していることを確認してください。 auth.jsonの Key が正しく、余計なスペースが入っていないことを確認してください。- config を変更した後は、再起動 してください。
接続エラー / タイムアウト / 404
接続エラー / タイムアウト / 404
/v1 がないこと です。正しい例: https://api.apiyi.com/v1。そのあと、ローカル proxy と DNS を確認してください。どのモデルがサポートされていますか?
どのモデルがサポートされていますか?
- OpenAI シリーズ: ✅ 完全対応(推奨
gpt-5.6-sol/gpt-5.6-terra/gpt-5.6-luna/gpt-5.5/gpt-5.4)。 - Grok シリーズ: ✅ ネイティブな responses protocol 対応 —
grok-4.5はwire_apiを触らずに動作します。詳細は Grok API Guide を参照してください。 - その他の OpenAI 互換モデル: APIYI でサポートされています。たとえば
glm-5.2です。modelフィールドを変更するだけです。 - 注: APIYI 上の Claude / Gemini は OpenAI 互換の chat モードのみを提供し、responses endpoint はありません。そのため Codex では
wire_apiを"chat"に切り替える必要があり、tool calling などの agent の挙動で互換性の問題が発生することがあります。Claude / Gemini ベースのコーディングには、各ネイティブツール(例: Claude Code / Gemini CLI)を使ってください。
デスクトップアプリ / 拡張機能が動作しませんか?
デスクトップアプリ / 拡張機能が動作しませんか?
~/.codex/config.toml + auth.json だけを読み込み、環境変数は読みません。この 2 つのファイルが正しいこと、認証方法が apikey に設定されていること、そして 再起動 することを確認してください。本番環境に適していますか?
本番環境に適していますか?
- CLI / アプリ: 開発時の生産性向上に最適です。
- 本番環境: 直接 API 呼び出しを優先してください(より細かな制御、監視、段階的なロールアウトが可能です)。
APIYI の設定をアンインストールまたは無効化するにはどうすればよいですか?
APIYI の設定をアンインストールまたは無効化するにはどうすればよいですか?
~/.codex/config.toml と auth.json を削除するか元に戻してください(デスクトップアプリ / 拡張機能については、それぞれの UI で管理します)。9. 概要
統合全体は一文で表せます。OpenAI のエンドポイントを APIYI に置き換える核心は
~/.codex/ を一度だけ設定することです。Key を auth.json に入れ、base_url を https://api.apiyi.com/v1 に向けて config.toml で指定します。その後は、デスクトップアプリ、IDE 拡張、CLI のすべてが動作します。それ以外のこと — モデルの選択、プロンプト、instructions.md、AGENTS.md — はすべて仕上げにすぎません。