@openai/agents 0.8.5 → 0.9.1

package/README.md

@@ -1,18 +1,17 @@
 # OpenAI Agents SDK (JavaScript/TypeScript)
 
-[![npm version](https://badge.fury.io/js/@openai%2Fagents.svg)](https://badge.fury.io/js/@openai%2Fagents)
-[![CI](https://github.com/openai/openai-agents-js/actions/workflows/test.yml/badge.svg)](https://github.com/openai/openai-agents-js/actions/workflows/test.yml)
+[![npm version](https://badge.fury.io/js/@openai%2Fagents.svg)](https://badge.fury.io/js/@openai%2Fagents) [![CI](https://github.com/openai/openai-agents-js/actions/workflows/test.yml/badge.svg)](https://github.com/openai/openai-agents-js/actions/workflows/test.yml)
 
 The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows in JavaScript/TypeScript. It is provider-agnostic, supporting OpenAI APIs and more.
 
 <img src="https://cdn.openai.com/API/docs/images/orchestration.png" alt="Image of the Agents Tracing UI" style="max-height: 803px;">
 
-> [!NOTE]
-> Looking for the Python version? Check out [OpenAI Agents SDK Python](https://github.com/openai/openai-agents-python).
+> [!NOTE] Looking for the Python version? Check out [OpenAI Agents SDK Python](https://github.com/openai/openai-agents-python).
 
 ## Core concepts
 
 1. [**Agents**](https://openai.github.io/openai-agents-js/guides/agents): LLMs configured with instructions, tools, guardrails, and handoffs
+1. [**Sandbox Agents**](https://openai.github.io/openai-agents-js/guides/sandbox-agents): Agents paired with a filesystem workspace and sandbox environment for longer-running work
 1. **[Agents as tools](https://openai.github.io/openai-agents-js/guides/tools/#4-agents-as-tools) / [Handoffs](https://openai.github.io/openai-agents-js/guides/handoffs/)**: Delegating to other agents for specific tasks
 1. [**Tools**](https://openai.github.io/openai-agents-js/guides/tools/): Various Tools let agents take actions (functions, MCP, hosted tools)
 1. [**Guardrails**](https://openai.github.io/openai-agents-js/guides/guardrails/): Configurable safety checks for input and output validation
@@ -43,7 +42,47 @@ Explore the [`examples/`](https://github.com/openai/openai-agents-js/tree/main/e
 npm install @openai/agents zod
 ```
 
-### Run your first agent
+### Run your first Sandbox Agent
+
+[Sandbox Agents](https://openai.github.io/openai-agents-js/guides/sandbox-agents) are in beta. A sandbox agent can inspect files, run commands, apply patches, and carry workspace state across longer tasks.
+
+```js
+import { run } from '@openai/agents';
+import { gitRepo, Manifest, SandboxAgent } from '@openai/agents/sandbox';
+import { UnixLocalSandboxClient } from '@openai/agents/sandbox/local';
+
+const agent = new SandboxAgent({
+  name: 'Workspace Assistant',
+  instructions: 'Inspect the sandbox workspace before answering.',
+  defaultManifest: new Manifest({
+    entries: {
+      repo: gitRepo({
+        repo: 'openai/openai-agents-js',
+        ref: 'main',
+      }),
+    },
+  }),
+});
+
+const result = await run(
+  agent,
+  'Inspect repo/README.md and summarize what this project does.',
+  {
+    sandbox: {
+      client: new UnixLocalSandboxClient(),
+    },
+  },
+);
+
+console.log(result.finalOutput);
+// This project provides a JavaScript/TypeScript SDK for building agent workflows.
+```
+
+(_If running this, ensure you set the `OPENAI_API_KEY` environment variable_)
+
+### Run an agent without a sandbox
+
+You can still use a regular `Agent` when your workflow does not need a filesystem workspace or sandbox lifecycle.
 
 ```js
 import { Agent, run } from '@openai/agents';
@@ -63,8 +102,6 @@ console.log(result.finalOutput);
 // Infinite loop's dance.
 ```
 
-(_If running this, ensure you set the `OPENAI_API_KEY` environment variable_)
-
 Explore the [`examples/`](https://github.com/openai/openai-agents-js/tree/main/examples) directory to see the SDK in action.
 
 ## Acknowledgements

package/dist/metadata.js

@@ -4,9 +4,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.METADATA = void 0;
 exports.METADATA = {
     "name": "@openai/agents",
-    "version": "0.8.5",
+    "version": "0.9.1",
     "versions": {
-        "@openai/agents": "0.8.5",
+        "@openai/agents": "0.9.1",
         "@openai/agents-core": "workspace:*",
         "@openai/agents-openai": "workspace:*",
         "@openai/agents-realtime": "workspace:*",

package/dist/metadata.mjs

@@ -1,9 +1,9 @@
 // This file is automatically generated
 export const METADATA = {
     "name": "@openai/agents",
-    "version": "0.8.5",
+    "version": "0.9.1",
     "versions": {
-        "@openai/agents": "0.8.5",
+        "@openai/agents": "0.9.1",
         "@openai/agents-core": "workspace:*",
         "@openai/agents-openai": "workspace:*",
         "@openai/agents-realtime": "workspace:*",

package/dist/sandbox/index.d.ts

@@ -0,0 +1 @@
+export * from '@openai/agents-core/sandbox';

package/dist/sandbox/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@openai/agents-core/sandbox"), exports);
+//# sourceMappingURL=index.js.map

package/dist/sandbox/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/sandbox/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA4C"}

package/dist/sandbox/index.mjs

@@ -0,0 +1,2 @@
+export * from '@openai/agents-core/sandbox';
+//# sourceMappingURL=index.mjs.map

package/dist/sandbox/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/sandbox/index.ts"],"names":[],"mappings":"cAAc,6BAA6B"}

package/dist/sandbox/local.d.ts

@@ -0,0 +1 @@
+export * from '@openai/agents-core/sandbox/local';

package/dist/sandbox/local.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@openai/agents-core/sandbox/local"), exports);
+//# sourceMappingURL=local.js.map

package/dist/sandbox/local.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.js","sourceRoot":"","sources":["../../src/sandbox/local.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oEAAkD"}

package/dist/sandbox/local.mjs

@@ -0,0 +1,2 @@
+export * from '@openai/agents-core/sandbox/local';
+//# sourceMappingURL=local.mjs.map

package/dist/sandbox/local.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.mjs","sourceRoot":"","sources":["../../src/sandbox/local.ts"],"names":[],"mappings":"cAAc,mCAAmC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@openai/agents",
   "repository": "https://github.com/openai/openai-agents-js",
   "homepage": "https://openai.github.io/openai-agents-js/",
-  "version": "0.8.5",
+  "version": "0.9.1",
   "description": "The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows.",
   "author": "OpenAI <support@openai.com>",
   "main": "dist/index.js",
@@ -13,6 +13,16 @@
       "require": "./dist/index.js",
       "import": "./dist/index.mjs"
     },
+    "./sandbox": {
+      "types": "./dist/sandbox/index.d.ts",
+      "require": "./dist/sandbox/index.js",
+      "import": "./dist/sandbox/index.mjs"
+    },
+    "./sandbox/local": {
+      "types": "./dist/sandbox/local.d.ts",
+      "require": "./dist/sandbox/local.js",
+      "import": "./dist/sandbox/local.mjs"
+    },
     "./realtime": {
       "types": "./dist/realtime/index.d.ts",
       "require": "./dist/realtime/index.js",
@@ -27,9 +37,9 @@
   "dependencies": {
     "debug": "^4.4.0",
     "openai": "^6.26.0",
-    "@openai/agents-core": "0.8.5",
-    "@openai/agents-openai": "0.8.5",
-    "@openai/agents-realtime": "0.8.5"
+    "@openai/agents-core": "0.9.1",
+    "@openai/agents-realtime": "0.9.1",
+    "@openai/agents-openai": "0.9.1"
   },
   "keywords": [
     "openai",
@@ -50,6 +60,12 @@
   ],
   "typesVersions": {
     "*": {
+      "sandbox": [
+        "dist/sandbox/index.d.ts"
+      ],
+      "sandbox/local": [
+        "dist/sandbox/local.d.ts"
+      ],
       "realtime": [
         "dist/realtime/index.d.ts"
       ],