クライアント/Codex

Codex で Wokey API を使う

Wokey の API キーを取得し、Codex の Base URL を Wokey に向けてから、curl リクエスト 1 回で接続を確認します。

更新日

このページの内容expand_more

API キーと Base URL を用意するlink

どのクライアントも、同じ Wokey API キーと同じ Base URL を使います。

API キーを作成する

ログインして API ページでプラットフォームのキーを作成します。同じアカウントのキーは残高を共有します。

API キーを作成key

Wokey の Base URL を使う

クライアントの Base URL にはゲートウェイのドメインを設定します。/v1 を付けるかどうかは以下の設定を参照してください。

クライアントを設定するlink

Codex CLI と Codex デスクトップアプリは同じ設定を共有するため、以下の設定は両方に適用されます。Codex は Responses プロトコルを使います。base_url はゲートウェイのオリジンのままにし、/responses は付けないでください。experimental_bearer_token の YOUR_API_KEY を Wokey の API キーに置き換え、Bearer プレフィックスは付けません。既存の env_key 設定は削除してください。環境変数の export は不要です。ファイルを保存して codex を実行します。キーはローカルの設定ファイルに平文で保存されます。

Codex
# ~/.codex/config.toml
model = "gpt-6-sol"
model_provider = "wokey"

[model_providers.wokey]
name = "Wokey"
base_url = "https://api.wokey.ai"
experimental_bearer_token = "YOUR_API_KEY"
wire_api = "responses"

# shell
codex

API 形式と Base URLlink

同じクライアントでも API 形式を切り替えると、Base URL の末尾に /v1 を付けるかどうかが変わることがあります。

形式Base URL用途
OpenAI Responseshttps://api.wokey.aiGPT モデル

設定場所: ~/.codex/config.toml

curl で確認するlink

クライアントがエラーを出す場合は、まず curl で API キーと Base URL の問題ではないことを確認します。

Codex はデフォルトで OpenAI Responses 形式を使います。このリクエストで 200 が返れば、API キーと Base URL は正しく設定されています。送信前に YOUR_API_KEY をご自身のキーに置き換えてください。

cURL
curl https://api.wokey.ai/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-6-sol",
    "instructions": "You are a helpful assistant.",
    "input": [
      { "role": "user", "content": "Hello" }
    ],
    "store": false,
    "stream": false
  }'

エラーとトラブルシューティングlink

まず認証、残高、レート制限、モデルの利用可否、アップストリームのタイムアウトのどれかを切り分けます。

401

invalid api key

キーがない、入力ミスがある、削除されている、または Authorization と x-api-key ヘッダーの内容が食い違っています。

402

insufficient balance

アカウントの残高が不足しています。リクエストを続ける前にチャージしてください。

403

model_denylisted / account_restricted

違反が繰り返されたため、そのモデル、またはアカウントのすべてのモデルへの呼び出しが停止されています。「違反処理手数料と制限」を参照してください。

403

request_blocked

このリクエストはアップストリームに届く前にブロックされ、課金されていません。たとえば、モデルが直前に拒否したリクエストを変更せずに再送した場合や、停止中のエンドユーザー(X-End-User-Id)の場合です。エラーメッセージに何がブロックされたかが示されるので、その内容に沿ってリクエストを変更するか、時間をおいて再試行してください。ほかのリクエストには影響しません。

429

rate limited

リクエストの頻度が高すぎます。時間をおいて再試行するか、同時実行数を減らしてください。特定のモデル、または特定のエンドユーザー(X-End-User-Id)だけが 429 を返し続ける場合は、違反後の一時的な制限の可能性があります。

499

client disconnected

レスポンスの完了前にクライアントが接続を閉じました(コード downstream_aborted)。デフォルトでは無料です。過去 24 時間にアカウントのクライアント切断が 50 回以上あり、それがリクエストの 10% 以上を占めると、以降の切断されたリクエストはアップストリームが報告した使用量で課金されます。対象は、キャッシュの読み書きを含む処理済みの入力と、アップストリームが計上した場合に限り出力です。アップストリームが使用量を報告する前に切断された場合は無料のままです。課金が始まるとアカウントに通知され、切断率が通常に戻ると 1 時間以内に課金は自動的に停止します。よくある原因は、クライアントやプロキシのタイムアウトが短すぎることや、プログラムが完了前にリクエストをキャンセルしていることです。

502

upstream unavailable

アップストリームのモデルサービスが一時的に利用できません。モデルを切り替えるか、時間をおいて再試行してください。

504

upstream timeout

アップストリームのレスポンスがタイムアウトしました。コンテキストを短くするか、max_tokens を減らすか、再試行してください。

529

upstream overloaded

アップストリームのモデルが一時的に過負荷になっており、Wokey はほかの経路での再試行を済ませています(コード upstream_overloaded)。残高とは関係ありません。少し待ってから再試行するか、モデルを切り替えてください。

よくある質問link

Codex の base_url に /v1 や /responses は必要ですか?
どちらも不要です。base_url には https://api.wokey.ai を指定してください。Codex は /responses を自動で付け足すため、手動で追加するとパスが重複します。
experimental_bearer_token に Bearer という語は必要ですか?
不要です。Wokey の API キーだけを貼り付け、古い env_key の行を削除してください。そうすれば環境変数は必要ありません。
wire_api には何を指定しますか?
responses です。Codex は OpenAI Responses 形式を使い、Wokey では GPT モデルをこの形式で呼び出します。

設定・エラーガイドlink