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. 跟踪进度。 通过流式输出或 Webhook,了解智能体何时完成工作或需要输入。
  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 平台的 数据控制