37 Commits

Author SHA1 Message Date
Kazuhiro Sera 727e729f21 docs: document v0.22.0 behavior changes (#4522) 2026-08-19 22:45:45 +09:00
Kazuhiro Sera f5d20e5e2f docs: improve translation source clarity (#4306) 2026-08-08 22:44:19 +09:00
Kazuhiro Sera ac1206294c docs: updates for 0.19.0 (#3872) 2026-07-28 07:51:20 +09:00
Umer Ali e78bb09275 docs: fix missing imports in dynamic instructions example (#3895)
Co-authored-by: Kazuhiro Sera <seratch@openai.com>
2026-07-20 22:01:30 +00:00
Kazuhiro Sera 2fa463571e docs: fix runnable Python examples (#3885) 2026-07-20 08:48:24 +09:00
Ali Adnan 825f1132ef docs: adjust code snippets (#3869) 2026-07-17 22:10:14 +00:00
Muhammad Hamid Raza 5e8d067bc0 docs: make UserContext example runnable in Agents documentation (#3851) 2026-07-17 07:14:33 +09:00
Kazuhiro Sera 133208381c feat: add GPT-5.6 model defaults and migrate examples (#3774) 2026-07-10 07:58:22 +09:00
Kazuhiro Sera a898061dfa docs: make markdown style consistent across the project 2026-07-04 09:04:30 +09:00
Illia Oleksiuk f9eb3a4f33 docs: mark Agent.instructions as optional (#3384) 2026-05-13 15:31:51 +09:00
Abdulrahman Alfozan c88f339d32 Update examples and defaults to GPT-5.5 (#3016) 2026-04-25 10:31:54 +09:00
HuxleyHu98 bd871cddb2 docs: clarify ToolContext availability in function-tool lifecycle hooks (#2687) 2026-04-16 02:55:53 +09:00
Steve Coffey 2d665c9a67 Sandbox Agents (#2889)
### Sandbox Agents

This release adds **Sandbox Agents**, a beta SDK surface for running
agents with a persistent, isolated workspace. Sandbox agents keep the
normal `Agent` and `Runner` flow, but add workspace manifests,
sandbox-native capabilities, sandbox clients, snapshots, and resume
support so agents can work over real files, run commands, edit
repositories, generate artifacts, and continue work across runs.

Key pieces:

- `SandboxAgent`: an `Agent` with sandbox defaults such as
`default_manifest`, sandbox instructions, capabilities, and `run_as`.
- `Manifest`: a fresh-workspace contract for files, directories, local
files, local directories, Git repos, environment, users, groups, and
mounts.
- `SandboxRunConfig`: per-run sandbox wiring for client creation, live
session injection, serialized session resume, manifest overrides,
snapshots, and materialization concurrency limits.
- Built-in capabilities for shell access, filesystem editing and image
inspection, skills, memory, and compaction.
- Workspace snapshots and serialized sandbox session state for
reconnecting to existing work or seeding a fresh sandbox from saved
contents.

### Sandbox clients and hosted providers

Sandbox agents now support local, containerized, and hosted execution
backends:

- `UnixLocalSandboxClient` for fast local development.
- `DockerSandboxClient` for container isolation and image parity.
- Hosted sandbox clients for Blaxel, Cloudflare, Daytona, E2B, Modal,
Runloop, and Vercel through optional extras.

The release also adds provider-specific examples and mount strategies
for common storage backends, including S3, Cloudflare R2, Google Cloud
Storage, Azure Blob Storage, and S3 Files where supported by the
selected backend.

### Sandbox memory

Adds a sandbox memory capability that lets future sandbox-agent runs
learn from prior runs. Memory stores extracted lessons in the sandbox
workspace, injects a concise summary into later runs, and uses
progressive disclosure so agents can search deeper rollout summaries
only when useful.

Memory supports:

- Read-only or generate-only modes.
- Live updates when the agent discovers stale memory.
- Multi-turn grouping through `conversation_id`, SDK `Session`,
`RunConfig.group_id`, or generated run IDs.
- Separate memory layouts for isolating memory across agents or
workflows.
- S3-backed examples for persisted memory across runs.

### Workspace mounts, snapshots, and resume

This release adds a full workspace entry and mount model for sandbox
sessions:

- Local files and directories.
- Synthetic files and directories.
- Git repository entries.
- Remote storage mounts for S3, R2, GCS, Azure Blob Storage, and S3
Files.
- Provider-specific mount strategies across Docker, Modal, Cloudflare,
Blaxel, Daytona, E2B, and Runloop.
- Portable snapshots with path normalization, symlink preservation,
mount-safe snapshotting, and remote snapshot support.
- Resume paths through runner-managed `RunState`, explicit
`SandboxSessionState`, or saved snapshots.

### Examples and tutorials

Adds a large `examples/sandbox/` suite covering:

- Local Unix and Docker sandbox runners.
- Docker mount smoke tests for S3, GCS, Azure Blob Storage, and S3
Files.
- Sandbox coding tasks with skills.
- Sandbox agents as tools and handoff patterns.
- Memory examples, including multi-agent/multi-turn memory and S3-backed
memory.
- Tax-prep and healthcare-support workflows.
- Dataroom QA and metric extraction tutorials.
- Repository code review tutorial.
- Vision website clone tutorial.
- Provider examples for Blaxel, Cloudflare, Daytona, E2B, Modal,
Runloop, Temporal, and Vercel.

### Runtime, tracing, and model plumbing

The release includes the runtime plumbing needed to make sandbox agents
work naturally inside the existing SDK:

- Runner-managed sandbox preparation, capability binding, session
lifecycle, state serialization, and resume behavior.
- Sandbox-aware `RunState` serialization.
- Unified sandbox tracing with SDK spans.
- Token usage on tracing spans.
- Runner-managed prompt cache key defaults.
- OpenAI agent registration and harness ID configuration.
- Safer redaction of sensitive MCP tool outputs when sensitive tracing
is disabled.
- Additional OpenAI client/model utilities and Chat Completions
coverage.


## Documentation & Other Changes

- docs: add Asqav to external tracing processors list.
- docs: update translated document pages.

Co-authored-by: Abdulrahman Alfozan <alfozan@openai.com>
Co-authored-by: Aditya Singh <60082699+adityasingh2400@users.noreply.github.com>
Co-authored-by: Andi Liu <andi@openai.com>
Co-authored-by: Aron <263346377+aron-cf@users.noreply.github.com>
Co-authored-by: ashwinnathan-openai <ashwinnathan@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: cploujoux <cploujoux@blaxel.ai>
Co-authored-by: elainegan-openai <168589666+elainegan-openai@users.noreply.github.com>
Co-authored-by: Elias Freider <freider@users.noreply.github.com>
Co-authored-by: Erik Dunteman <erik@erikds-macbook-air.local>
Co-authored-by: Jason Liu <jasonliu@openai.com>
Co-authored-by: Jason Steving <32336750+jasonsteving99@users.noreply.github.com>
Co-authored-by: Kazuhiro Sera <seratch@openai.com>
Co-authored-by: Lovre Pešut <lovre.pesut@gmail.com>
Co-authored-by: Lucas Wang <lucas_wang@lucas-futures.com>
Co-authored-by: Matt Brockman <matt.brockman@e2b.dev>
Co-authored-by: Mish Ushakov <mishushakov@users.noreply.github.com>
Co-authored-by: Naresh <ghostwriternr@gmail.com>
Co-authored-by: nicholasclark-openai <nicholasclark@openai.com>
Co-authored-by: qiyaoq-oai <qiyaoq@openai.com>
Co-authored-by: Scott Trinh <scott@scotttrinh.com>
Co-authored-by: tode-rl <tony@runloop.ai>
Co-authored-by: Wendy Jiao <wendyjiao@openai.com>
2026-04-15 10:00:40 -07:00
Kazuhiro Sera 557b97e062 docs: update pages to include recent changes 2026-03-13 16:48:35 +09:00
Kazuhiro Sera 1215783363 docs: add tool search coverage across Python guides (#2622) 2026-03-09 13:39:30 +09:00
Kazuhiro Sera 8d1094d21b docs: refresh docs and examples to gpt-5.4 (#2615) 2026-03-07 01:45:49 +09:00
Kazuhiro Sera d6f950d086 docs: clarify agent runtime, handoff, HITL, and results flows (#2596) 2026-03-04 18:11:23 +09:00
Kazuhiro Sera c4a87ab887 docs: improve consistency 2026-03-03 09:43:47 +09:00
Kazuhiro Sera ee674b8eca docs: update a few docs and code comments (#2564) 2026-03-01 13:13:36 +09:00
Kazuhiro Sera 8490023d15 docs: add prompt template setup steps and MCP server manager guide (#2362) 2026-01-24 08:03:33 +09:00
Kazuhiro Sera 05424cebc6 docs: update a few pages 2026-01-17 12:23:18 +09:00
cguo-oai 4b3986b304 docs: Upgrading to GPT-5.2 (#2188)
Co-authored-by: Kazuhiro Sera <seratch@openai.com>
2025-12-16 08:26:32 +09:00
Kazuhiro Sera c2ee7c890c Update models in docs (#1810) 2025-09-26 15:50:14 +09:00
Kazuhiro Sera b302974d47 docs: Add more clarity on multi-agent design patterns (#1650)
This pull request updates the "Agents" documentation page to mention
both manger and handoffs design patterns. I've got a feedback from a
customer that the Agents SDK documentation does not mention the "agents
as tools" design pattern when mentioning handoffs, so he thought this
SDK supports only handoffs. This is a valid feedback, so we can consider
improving the documentation to give more clarity.
2025-09-04 06:28:25 +09:00
AS 5f560be6c7 docs: Fix #1625 code snippet error
Resolves #1625
2025-09-01 03:21:30 +00:00
Abbas Asad 7560cabb46 Docs: Clarify that guardrails apply to both user input and agent output (#1482) 2025-08-15 08:33:58 +09:00
Muhammad Hamid Raza d968d7f62c Enhance Tool Behavior Documentation for Developer Clarity With Examples (#1286)
Co-authored-by: Kazuhiro Sera <seratch@openai.com>
2025-07-29 17:19:39 +09:00
Sameer Kankute 2224d45f42 docs: fix UserContext example (#1280) 2025-07-28 23:53:48 +00:00
mutahirshah11 a16da90a19 Adding docstring to get_weather tool (#1231) 2025-07-24 08:09:07 +00:00
Anees 586d4b2829 docs: mention 'name' is required in Agent constructor . fix: mention 'name' as required in Agent init doc (#1033)
## What

Updated the docs under `docs/agents.md` to clarify that the `name`
argument is required when initializing an `Agent`.

## Why

Without this clarification, users get a confusing error:
`TypeError: Agent.__init__() missing 1 required positional argument:
'name'`

This matches the actual constructor in the source code and helps future
devs avoid frustration.

## Reference

- Source:
[`agent.py`](https://github.com/openai/openai-agents-python/blob/main/src/agents/agent.py)
2025-07-08 11:10:42 -04:00
Kazuhiro Sera 68c725f942 Improve translation pipeline details (#475)
This pull request improves the translation pipeline, which was
introduced by #460. Now the document generation works pretty well with
gpt-4o model.
2025-04-10 16:54:05 -04:00
Rohan Mehta 6fb5792b77 Make the reset behavior on tool use configurable
## Summary:

#263 added this behavior. The goal was to prevent infinite loops when tool choice was set. The key change I'm making is:
1. Making it configurable on the agent.
2. Doing bookkeeping in the Runner to track this, to prevent mutating agents.
3. Not resetting the global tool choice in RunConfig.

## Test Plan:
Unit tests.
.
2025-03-25 13:29:32 -04:00
xianghuijin 8f2f76cb65 docs: Update tool_choice reset documentation to match implementation 2025-03-22 14:22:47 +08:00
xianghuijin d169d79288 Update documentation for tool_choice auto-reset feature 2025-03-20 21:49:38 +08:00
Rohan Mehta 10aa5555af Introduce tool_use_behavior on agents 2025-03-18 21:55:12 -04:00
jhills20 a373162bb0 use @function_tool decorator in docs 2025-03-12 11:15:42 -07:00
Rohan Mehta aaec57a426 Initial commit 2025-03-11 09:42:28 -07:00