Skip to content

add examples section to docs #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Examples

Check out a variety of sample implementations of the SDK in the examples section of the [repo](https://github.com/openai/openai-agents-python/tree/main/examples). The examples are organized into several categories that demonstrate different patterns and capabilities.


## Categories

- **agent_patterns**
Examples in this category illustrate common agent design patterns, such as:
- Deterministic workflows
- Agents as tools
- Parallel agent execution

- **basic**
These examples showcase foundational capabilities of the SDK, such as:
- Dynamic system prompts
- Streaming outputs
- Lifecycle events

- **tool examples**
Learn how to implement OAI hosted tools such as web search and file search,
and integrate them into your agents.

- **model providers**
Explore how to use non-OpenAI models with the SDK.

- **handoffs**
See practical examples of agent handoffs.

- **customer_service & research_bot**
Two more built-out examples that illustrate real-world applications:
- **customer_service**: Example customer service system for an airline.
- **research_bot**: Simple deep research clone.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ theme:
nav:
- Intro: index.md
- Quickstart: quickstart.md
- Examples: examples.md
- Documentation:
- agents.md
- running_agents.md
Expand Down