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

Blaxel

在 Blaxel 沙盒中运行 Agents API 会话。

请参阅 OpenAI Cookbook 中的应用管理Webhook 管理示例。

有关执行器设置和连接要求,请参阅自行托管的沙盒

选择一种资源预配模式:

  • 应用管理 按照本指南,从您的应用中启动和停止沙盒。
  • Webhook 管理 部署一个处理程序,根据 OpenAI Webhook 启动或重新连接沙盒。

请参阅沙盒生命周期,了解这两种模式的对比。

开始之前

您需要一个 OpenAI 项目 API 密钥、一个 Blaxel API 密钥和工作空间,以及 Codex CLI 软件包。

设置 BL_API_KEYBL_WORKSPACE,并使用 OPENAI_API_KEY 发起应用请求。将 OPENAI_EXECUTOR_API_KEY 设置为一个环境密钥,并仅将该密钥以 CODEX_API_KEY 的形式传入沙盒。

在您的资源预配代码中选择沙盒区域。如果需要下文介绍的 Agent Drive 持久化选项,请使用 us-was-1

1. 设置 Blaxel 环境

创建一个自托管会话并保存其环境 ID。使用 Blaxel SDK 或 API 创建一个隔离的沙盒,并采用配置的工作目录。在沙盒中安装 Codex CLI,然后使用该环境 ID 和环境密钥启动其执行器

Blaxel Node 镜像使用 Alpine Linux,因此请使用 apk 安装 ripgrep。将环境密钥以 CODEX_API_KEY 的形式仅传递给执行器进程。设置 keep_alive=True,以防止沙盒在执行器运行期间缩容至零。为设置过程、执行器和沙盒设定超时时限,可防止遗留资源无限期运行。

对于日常使用,请构建一个预装 Codex 和 ripgrep 的 Blaxel 镜像,让沙盒能够更快建立连接。

2. 运行会话

Blaxel 执行器连接后,使用运行和继续会话中的 HTTP 示例发送输入并流式接收结果。完成后,请删除会话,并另行停止提供商的沙盒。

请先启动沙盒,再提交输入。该轮次会等待环境连接,会话则通过事件流中的 agent.session.environment.connected 报告连接情况。

使用 agent.session.turn.completed 确认轮次是否成功。失败或取消的轮次之后也可能出现 agent.session.idle,因此请勿将会话处于空闲状态视为轮次成功的证据。

可选:在会话之间持久保存文件

使用 Blaxel Agent Drive 跨沙盒和会话保留文件。在每个沙盒中挂载同一个驱动器即可共享文件;Agent Drive 要求使用 us-was-1 区域,且不会传输对话历史记录或会话状态。

参考资料