Codex SDK

如果您透過 Codex CLI、IDE 擴充功能或 Codex 雲端使用 Codex，也可以透過程式控制 Codex。

需要進行下列操作時，請使用 SDK：

• 在 CI/CD 管線中控制 Codex
• 建立自己的智慧體，讓它能與 Codex 互動，以執行複雜的工程任務
• 將 Codex 整合至您自己的內部工具與工作流程
• 將 Codex 整合至您自己的應用程式

請將 Codex SDK 用於以程式設計為重點的 Codex 執行緒。如果在更廣泛的編排工作流程中，Codex 是其中一個專責元件， 請將 Codex CLI 作為 MCP 伺服器執行，並使用智慧體 SDK 加以編排。

如果您具備測試版存取權，且需要掃描程式碼庫或變更，以取得結構化的 安全性發現結果與涵蓋範圍，請使用 Codex Security TypeScript SDK。

TypeScript 程式庫

TypeScript 程式庫可讓您的應用程式啟動、延續及恢復本機 Codex 執行緒。

請在伺服器端使用此程式庫；它需要 Node.js 18 或更新版本。

安裝

若要開始使用，請使用 npm 安裝 Codex SDK：

npm install @openai/codex-sdk

使用方式

使用 Codex 啟動執行緒，並在其中執行您的提示詞。

const codex = new Codex();
const thread = codex.startThread();
const result = await thread.run(
  "Make a plan to diagnose and fix the CI failures"
);

console.log(result.finalResponse);

再次呼叫 run() 可繼續同一個執行緒；您也可以提供執行緒 ID，以恢復先前的執行緒。

// running the same thread
const result = await thread.run("Implement the plan");

console.log(result.finalResponse);

// resuming past thread

const threadId = "<thread-id>";
const thread2 = codex.resumeThread(threadId);
const result2 = await thread2.run("Pick up where you left off");

console.log(result2.finalResponse);

如需更多詳細資訊，請參閱 TypeScript 程式碼庫。

Python 程式庫

Python SDK 會透過 JSON-RPC 控制本機 Codex app-server。它需要 Python 3.10 或更新版本。已發佈的 SDK 組建包含固定版本的 Codex CLI 執行階段相依套件。

安裝

若要安裝 SDK，請執行：

pip install openai-codex

已發佈的 SDK 組建會自動使用各自固定版本的執行階段。只有在您確實想改用特定的本機 Codex 可執行檔時，才傳入 CodexConfig(codex_bin=...)。

Python SDK 已推出穩定版。 pip install openai-codex 會安裝最新的穩定版。請使用 pip install --pre openai-codex 來選擇 安裝較新的預發行版本。

使用方式

啟動 Codex、建立執行緒，並執行提示詞：

from openai_codex import Codex, Sandbox

with Codex() as codex:
    thread = codex.thread_start(
        model="gpt-5.6-terra",
        sandbox=Sandbox.workspace_write,
    )
    result = thread.run("Make a plan to diagnose and fix the CI failures")
    print(result.final_response)

若您的應用程式已採用非同步處理，請使用 AsyncCodex：

from openai_codex import AsyncCodex


async def main() -> None:
    async with AsyncCodex() as codex:
        thread = await codex.thread_start(model="gpt-5.6-terra")
        result = await thread.run("Implement the plan")
        print(result.final_response)


asyncio.run(main())

沙盒預設設定

使用相同的 Sandbox 預設設定來建立執行緒，或在後續輪次中變更該執行緒的檔案系統 存取權：

from openai_codex import Codex, Sandbox

with Codex() as codex:
    thread = codex.thread_start(sandbox=Sandbox.workspace_write)
    thread.run("Make the requested change.")
    review = thread.run("Review the diff only.", sandbox=Sandbox.read_only)

可用的預設設定如下：

• Sandbox.read_only：可讀取檔案，但不允許寫入。
• Sandbox.workspace_write：可讀取檔案，並可在工作區與已設定的可寫入根目錄中寫入。
• Sandbox.full_access：執行時不受檔案系統存取限制。

省略 sandbox= 時，app-server 會使用已設定的預設值。若將沙盒 傳入 run(...) 或 turn(...)，該設定會套用至該輪次及後續輪次 ，適用範圍限於同一個執行緒。

如需更多詳細資訊，請參閱 Python 程式碼庫。