package
The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows.
npm install @openai/agentsGitHub-flavored package documentation.
Across all versions, last 30 days.
9,421,587 in 30 days
Runtime metadata.
Tagged topics.
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.
[!NOTE] Looking for the Python version? Check out OpenAI Agents SDK Python.
Explore the examples/ directory to see the SDK in action.
nodejs_compat enabledCheck out the documentation for more detailed information.
npm install @openai/agents zodUse a regular Agent for text-based workflows that do not need a sandbox workspace or Realtime session.
import { Agent, run } from '@openai/agents';
const agent = new Agent({
name: 'Assistant',
instructions: 'You are a helpful assistant.',
});
const result = await run(
agent,
'Write a haiku about recursion in programming.',
);
console.log(result.finalOutput);Use a Sandbox Agent when the agent should work in a filesystem, run commands, or carry workspace state across longer tasks.
This example uses UnixLocalSandboxClient, which is supported on macOS and Linux. On Windows, use DockerSandboxClient or a hosted sandbox client instead; see Sandbox clients for setup details.
import { run } from '@openai/agents';
import { gitRepo, SandboxAgent } from '@openai/agents/sandbox';
import { UnixLocalSandboxClient } from '@openai/agents/sandbox/local';
const agent = new SandboxAgent({
name: 'Workspace Assistant',
model: 'gpt-5.5',
instructions: 'Inspect the repo before changing files.',
defaultManifest: {
entries: { repo: gitRepo({ repo: 'openai/openai-agents-js' }) },
},
});
const result = await run(
agent,
'Inspect the repo README and summarize what this project does.',
{ sandbox: { client: new
Use a Realtime Agent for low-latency, spoken interactions in the browser.
import { RealtimeAgent, RealtimeSession } from '@openai/agents/realtime';
const agent = new RealtimeAgent({
name: 'Assistant',
instructions: 'You are a helpful assistant.',
});
// Automatically connects your microphone and audio output in the browser via WebRTC.
const session = new RealtimeSession(agent);
await session.connect({ apiKey: '<client-api-key>' });Set OPENAI_API_KEY in your server environment for text and sandbox agents. For browser-based realtime agents, use your server to create a short-lived ephemeral client token and pass it to session.connect(...).
Explore the examples/ directory to see the SDK in action.
We'd like to acknowledge the excellent work of the open-source community, especially:
We're committed to building the Agents SDK as an open source framework so others in the community can expand on our approach.
For more details, see the documentation or explore the examples/ directory.
tino-openai
tino@openai.com
tylersmith-openai
tylersmith@openai.com
mdangelo-openai
mdangelo@openai.com
victor-openai
victor@openai.com
jbeckwith-oai
jbeckwith@openai.com
wadih-openai
wadih@openai.com
atty-openai
atty@openai.com
tibo-openai
tibo@openai.com
dkundel-openai
dkundel@openai.com
mbolin-openai
mbolin@openai.com
fouad-openai
fouad@openai.com
easong-openai
easong@openai.com
aibrahim-openai
ahmedibrhm32@gmail.com
apcha-oai
apcha@openai.com
seratch-openai
seratch@openai.com
Estimated unpacked size across 17 packages.
54.5 MB
Includes dependencies.
4 direct dependencies.
^7.45.1
7.57.0
0.22.0
0.22.0
0.22.0
0.22.0
0.22.0
0.22.0