Skip to content

Commit b4cd219

Browse files
committed
docs: add FAQ section for common questions
1 parent 9a207b6 commit b4cd219

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,44 @@ print(result.final_output)
8484

8585
Explore the [examples](https://github.com/openai/openai-agents-python/tree/main/examples) directory to see the SDK in action, and read our [documentation](https://openai.github.io/openai-agents-python/) for more details.
8686

87+
88+
## Frequently Asked Questions
89+
90+
### Which LLM providers are supported?
91+
92+
The SDK is provider-agnostic. While optimized for OpenAI models via the Responses and Chat Completions APIs, it supports 100+ other LLMs through the [any-llm](https://github.com/mozilla-ai/any-llm) and [LiteLLM](https://github.com/BerriAI/litellm) integrations.
93+
94+
### How do I handle rate limits?
95+
96+
The SDK includes built-in retry logic with exponential backoff. You can customize retry behavior via the `RunConfig` by setting `max_retries` and configuring the underlying HTTP client. For high-throughput scenarios, consider implementing request queuing or batching.
97+
98+
### Can I use the SDK without an OpenAI API key?
99+
100+
Yes. If you use a non-OpenAI provider through the any-llm or LiteLLM integration, you only need that provider's API key. Set the appropriate environment variable for your chosen provider.
101+
102+
### How do sandbox agents work?
103+
104+
Sandbox agents (introduced in v0.14.0) run inside a containerized environment with filesystem access. They are ideal for tasks that require inspecting files, running commands, applying patches, or maintaining workspace state across longer operations. Configure the sandbox via `SandboxRunConfig` with your preferred sandbox client.
105+
106+
### What is the difference between agents as tools and handoffs?
107+
108+
**Agents as tools** lets an agent call another agent as a tool — the calling agent retains control and can continue its work after the tool call returns. **Handoffs** transfer full control to another agent, which then becomes responsible for the conversation until it hands back or completes the task. Use tools for subtasks; use handoffs for role transitions.
109+
110+
### How do I debug agent runs?
111+
112+
The SDK includes built-in tracing that records every agent run. View traces in the OpenAI dashboard or export them to your preferred observability platform. Use the `tracing` module to add custom spans and annotations for deeper insight.
113+
114+
### Is the SDK production-ready?
115+
116+
Yes. The SDK is used in production by many organizations. It includes guardrails for input/output validation, human-in-the-loop patterns for critical decisions, and comprehensive observability. Review the [security documentation](https://openai.github.io/openai-agents-python/security/) for best practices.
117+
118+
### Where can I get help?
119+
120+
- **Documentation**: [openai.github.io/openai-agents-python](https://openai.github.io/openai-agents-python/)
121+
- **Examples**: [examples/](https://github.com/openai/openai-agents-python/tree/main/examples) directory
122+
- **GitHub Issues**: [Report bugs or request features](https://github.com/openai/openai-agents-python/issues)
123+
- **Discord**: Join the community for discussions and support
124+
87125
## Acknowledgements
88126

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

0 commit comments

Comments
 (0)