openai--openai-agents-python/README.md

OpenAI Agents SDK

The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows. It is provider-agnostic, supporting the OpenAI Responses and Chat Completions APIs, as well as 100+ other LLMs.

Note

Looking for the JavaScript/TypeScript version? Check out Agents SDK JS/TS.

Core concepts:

1. Agents: LLMs configured with instructions, tools, guardrails, and handoffs
2. Sandbox Agents: Agents preconfigured to work with a container to perform work over long time horizons.
3. Agents as tools / Handoffs: Delegating to other agents for specific tasks
4. Tools: Various Tools let agents take actions (functions, MCP, hosted tools)
5. Guardrails: Configurable safety checks for input and output validation
6. Human in the loop: Built-in mechanisms for involving humans across agent runs
7. Sessions: Automatic conversation history management across agent runs
8. Tracing: Built-in tracking of agent runs, allowing you to view, debug and optimize your workflows
9. Realtime Agents: Build powerful voice agents with gpt-realtime-1.5 and full agent features

Explore the examples directory to see the SDK in action, and read our documentation for more details.

Get started

To get started, set up your Python environment (Python 3.10 or newer required), and then install OpenAI Agents SDK package.

venv

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install openai-agents

For voice support, install with the optional voice group: pip install 'openai-agents[voice]'. For Redis session support, install with the optional redis group: pip install 'openai-agents[redis]'.

uv

If you're familiar with uv, installing the package would be even easier:

uv init
uv add openai-agents

For voice support, install with the optional voice group: uv add 'openai-agents[voice]'. For Redis session support, install with the optional redis group: uv add 'openai-agents[redis]'.

Run your first Sandbox Agent

Sandbox Agents are new in version 0.14.0. A sandbox agent is an agent that uses a computer environment to perform real work with a filesystem, in an environment you configure and control. Sandbox agents are useful when the agent needs to inspect files, run commands, apply patches, or carry workspace state across longer tasks.

from agents import Runner
from agents.run import RunConfig
from agents.sandbox import Manifest, SandboxAgent, SandboxRunConfig
from agents.sandbox.entries import GitRepo
from agents.sandbox.sandboxes import UnixLocalSandboxClient

agent = SandboxAgent(
    name="Workspace Assistant",
    instructions="Inspect the sandbox workspace before answering.",
    default_manifest=Manifest(
        entries={
            "repo": GitRepo(repo="openai/openai-agents-python", ref="main"),
        }
    ),
)

result = Runner.run_sync(
    agent,
    "Inspect the repo README and summarize what this project does.",
    # Run this agent on the local filesystem
    run_config=RunConfig(sandbox=SandboxRunConfig(client=UnixLocalSandboxClient())),
)
print(result.final_output)

# This project provides a Python SDK for building multi-agent workflows.

(If running this, ensure you set the OPENAI_API_KEY environment variable)

(For Jupyter notebook users, see hello_world_jupyter.ipynb)

Explore the examples directory to see the SDK in action, and read our documentation for more details.

Acknowledgements

We'd like to acknowledge the excellent work of the open-source community, especially:

• Pydantic
• Requests
• MCP Python SDK
• Griffe

This library has these optional dependencies:

• websockets
• SQLAlchemy
• any-llm and LiteLLM

We also rely on the following tools to manage the project:

• uv and ruff
• mypy and Pyright
• pytest and Coverage.py
• MkDocs

We're committed to continuing to build the Agents SDK as an open source framework so others in the community can expand on our approach.