For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
主要導覽

Agents API

使用託管的 Codex 任務執行框架,打造可持續保存狀態的雲端智慧體。

Agents API 讓你的應用程式透過 OpenAI 管理的 API 存取 Codex 任務執行框架。

OpenAI 負責管理工作階段、編排、上下文壓縮與復原,而你的應用程式則負責提供工具並選擇執行環境。

智慧體可以在沙盒中運作,執行程式碼、編輯檔案、連線至 MCP 伺服器,並產生成品。

定價

模型用量依所選模型的 API 費率計費。OpenAI 工具採用各自的標準費率,OpenAI 託管的沙盒則採用標準容器費率

試用範例

試用以下完整範例:

探索完整的應用程式:

核心概念

Agents API 以四個主要概念為基礎:

  • 智慧體: 智慧體可使用的模型、指示、工具與 MCP 伺服器。
  • 環境: 可選用的沙盒或電腦,供智慧體存取檔案、載入技能及執行指令。
  • 工作階段: 可持續保存狀態的智慧體執行個體,用來處理任務並回應輸入。
  • 事件與項目: 傳送給智慧體的輸入,以及工作階段中產生的輸出。

工作階段的完整流程

依照快速入門,從 OpenAI 託管的沙盒開始:

  1. 建立工作階段。 設定智慧體;OpenAI 會佈建其環境。
  2. 指派任務。 環境準備就緒後,使用者輸入就會啟動一回合的工作。
  3. 追蹤進度。 透過串流接收輸出,或使用 webhooks 得知智慧體何時完成工作或需要輸入。
  4. 繼續工作或引導方向。 將另一項任務傳送至同一個工作階段,或在智慧體目前的回合中提供引導。

使用 OpenAI 託管的工作階段時,你的應用程式負責傳送輸入與接收事件,OpenAI 則負責執行智慧體,並佈建及管理其沙盒。如需設定方式與限制,請參閱環境選項

你的應用程式啟動工作階段,並從 Agents API 接收事件與輸出。OpenAI 負責執行託管的 Codex 任務執行框架,並佈建及管理其沙盒。

託管任務執行框架提供的功能

託管的 Codex 任務執行框架支援:

  • 在沙盒中執行指令與程式碼。
  • 套用相關技能與指示。
  • 透過工具或 MCP 連線至外部資料。
  • 在智慧體工作時引導其方向。
  • 摘要先前的工作,以管理上下文視窗。
  • 將工作拆分為子任務,並委派給子代理程式。
  • 從上次停止的地方繼續工作階段。

請參閱快速入門的先決條件,了解 API 金鑰權限與 SDK 設定。建立工作階段時,請設定這些能力:

設定託管任務執行框架的能力
from openai import OpenAI

client = OpenAI()

session = client.beta.agents.sessions.create(
    agent={
        "model": "gpt-6-astra",
        "instructions": "Use the OpenAI documentation MCP and web search to answer technical questions accurately. Delegate independent research tasks to subagents when useful.",
        "tools": [
            {"type": "programmatic_tool_calling"},
            {
                "type": "mcp",
                "server_label": "openai_docs",
                "transport": {
                    "type": "http",
                    "server_url": "https://developers.openai.com/mcp",
                },
            },
            {"type": "web_search"},
        ],
        "multi_agent": {"enabled": True, "max_concurrent_subagents": 4},
    },
    environment={
        "type": "self_hosted",
        "workspace_directory": "/workspace",
        "capability_directories": ["/workspace/capabilities/skills"],
    },
    input=[
        {
            "role": "user",
            "content": [
                {
                    "type": "input_text",
                    "text": "Research how to connect an MCP server to an OpenAI agent, check for recent updates, and summarize the recommended setup.",
                }
            ],
        }
    ],
)
print(session.id)

如需比較執行階段,請參閱智慧體概覽

Agents API 會保留工作階段狀態,讓你能跨回合繼續工作,無須 重建對話上下文。不再需要工作階段與已發布的成品時, 你可以將其刪除。 Agents API 目前僅支援在美國的資料駐留, 且不支援零資料保留 (ZDR)。即使選擇自行託管的沙盒, Agents API 也不符合 ZDR 資格。請參閱 OpenAI 平台的 資料控制, 了解資料駐留與保留的詳細資訊。