Codex SDK

CI を含むコーディング作業の自動化、社内ツールやワークフローへの組み込み、自社アプリケーションへの統合に使えます。Codex と連携して複雑なエンジニアリング作業をこなす独自のエージェントも作れます。ライブラリは TypeScript 版と Python 版があります。

Codex SDK には TypeScript と Python の 2 つのライブラリがあります。

• TypeScript ライブラリ: サーバー側で使うライブラリで、Node.js 18 以降が必要です。ローカルの Codex のスレッドを開始・継続・再開できます。スレッド作成時に threadSource を指定すると連携先が作ったスレッドを識別でき、スレッドを再開しても元の source は保たれます。
• Python ライブラリ: JSON-RPC でローカルの Codex app-server を操作します。Python 3.10 以降が必要で、pip install openai-codex でインストールします。公開されているビルドには、バージョンを固定した Codex CLI ランタイムが依存関係として含まれます。特定のローカルの Codex 実行ファイルを意図して使う場合だけ CodexConfig(codex_bin=...) を渡します。アプリケーションがすでに非同期で書かれている場合は AsyncCodex を使います。

設定の上書き

TypeScript ライブラリでは、config で構造化された Codex の設定を渡します。ドット区切りのパスで表せないキーには、configOverrides で生の TOML 文字列を個別の --config 引数として渡します。生の上書きは構造化された config より優先されます。これらの上書きは Codex の設定ファイルを変更しません。

サービスティア

run() または turn() に turn_service_tier を渡すと、新しい 1 ターンだけのサービスティアを選べます。service_tier を渡すと、そのターンと以降のターンのティアが変わります。

サンドボックスのプリセット

スレッドの作成時と、後のターンでファイルシステムへのアクセスを変えるときに、同じ Sandbox のプリセットを使えます。

• Sandbox.read_only: ファイルを読み取り、書き込みは許可しません。
• Sandbox.workspace_write: ファイルを読み取り、ワークスペースと設定済みの書き込み可能なルートの中に書き込みます。
• Sandbox.full_access: ファイルシステムへのアクセス制限なしで実行します。

sandbox= を省略すると、app-server は設定済みの既定値を使います。run(...) または turn(...) に渡したサンドボックスは、そのターンとスレッド上の以降のターンに適用されます。

ツール、アプリケーション、別のエージェントから来た内容は、ExternalMessage として thread.run() または thread.turn() の入力全体に渡せます。Codex はこの内容をツールの出力として扱い、ユーザーや開発者の指示より低い優先度に置きます。

codex.thread_resume() または codex.thread_fork() に include_turns=False を渡すと、古いターンをレスポンスに読み込まずにスレッドを再開できます。履歴が後で必要になったときは thread.read(include_turns=True) を呼びます。モデルのプロバイダーを切り替えた場合は、codex.thread_fork(thread_id) で同じ履歴から新しいプロバイダー上で続けられます。

TypeScript ライブラリでの基本的な流れです。

1. npm install @openai/codex-sdk で TypeScript 用の Codex SDK をインストールします。
2. Codex でスレッドを開始し、プロンプトを渡して実行します。
3. 同じスレッドで続けるときは run() をもう一度呼びます。過去のスレッドを再開するときは、スレッド ID を指定します。