Skip to content

Repository files navigation

OpenAI Agents SDK PyPI

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.

Image of the Agents Tracing UI

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. Realtime agents: Build powerful voice agents with gpt-realtime-2.1 and full agent features
  4. Voice agents: Build voice pipelines that combine speech-to-text, an agent workflow, and text-to-speech
  5. Agents as tools / Handoffs: Delegating to other agents for specific tasks
  6. Tools: Various Tools let agents take actions (functions, MCP, hosted tools)
  7. Guardrails: Configurable safety checks for input and output validation
  8. Human in the loop: Built-in mechanisms for involving humans across agent runs
  9. Sessions: Automatic conversation history management across agent runs
  10. Tracing: Built-in tracking of agent runs, allowing you to view, debug and optimize your workflows

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 agents

The SDK supports four primary ways to run agents. Set the OPENAI_API_KEY environment variable before running any of these examples.

Run a text agent

Use a text Agent for workflows that do not need a persistent realtime connection or a sandbox workspace.

fromagentsimportAgent, Runneragent=Agent(name="Assistant", instructions="You are a helpful assistant")
result=Runner.run_sync(agent, "Write a haiku about recursion in programming.")
print(result.final_output)
# Code within the code,# Functions calling themselves,# Infinite loop's dance.

(For Jupyter notebook users, see hello_world_jupyter.ipynb)

Run a sandbox agent

Use a SandboxAgent when the agent needs to inspect files, run commands, apply patches, or preserve workspace state across longer tasks.

This example uses UnixLocalSandboxClient, which is supported on macOS and Linux. On Windows, use DockerSandboxClient with the openai-agents[docker] extra or a hosted sandbox client instead; see Sandbox clients for setup details.

fromagentsimportRunnerfromagents.runimportRunConfigfromagents.sandboximportManifest, SandboxAgent, SandboxRunConfigfromagents.sandbox.entriesimportGitRepofromagents.sandbox.sandboxesimportUnixLocalSandboxClientagent=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_config=RunConfig(sandbox=SandboxRunConfig(client=UnixLocalSandboxClient())),
)
print(result.final_output)

Run a realtime agent

Use a RealtimeAgent for low-latency, server-side voice and multimodal experiences over WebSocket.

importasynciofromagents.realtimeimportRealtimeAgent, RealtimeRunnerasyncdefmain() ->None:
agent=RealtimeAgent(name="Assistant", instructions="You are a helpful voice assistant. Keep responses short.")
runner=RealtimeRunner(starting_agent=agent)
session=awaitrunner.run()
asyncwithsession:
awaitsession.send_message("Say hello in one short sentence.")
asyncforeventinsession:
ifevent.type=="audio":
# Forward or play event.audio.data.passelifevent.type=="history_added":
print(event.item)
elifevent.type=="agent_end":
breakif__name__=="__main__":
asyncio.run(main())

Run a voice agent

Use a VoicePipeline to turn audio into text, run an agent workflow, and stream generated speech.

importasyncioimportnumpyasnpfromagentsimportAgentfromagents.voiceimportAudioInput, SingleAgentVoiceWorkflow, VoicePipelineasyncdefmain() ->None:
agent=Agent(name="Assistant", instructions="You are a helpful voice assistant.")
pipeline=VoicePipeline(workflow=SingleAgentVoiceWorkflow(agent))
audio_input=AudioInput(buffer=np.zeros(24000*3, dtype=np.int16))
result=awaitpipeline.run(audio_input)
asyncforeventinresult.stream():
ifevent.type=="voice_stream_event_audio":
# Forward or play event.data.passif__name__=="__main__":
asyncio.run(main())

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:

This library has these optional dependencies:

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

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.

About

A lightweight, powerful framework for multi-agent workflows

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages