docs(agent): Add openresponses guide - #7930
Draft
charlesbvll wants to merge 1 commit into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds documentation for using the OpenAI Python SDK inside an AgentApp by calling Flower’s internal Open Responses-compatible runtime endpoint, and updates existing docs to reference/clarify this behavior.
Changes:
- Added a new how-to guide for using the OpenAI SDK in an AgentApp via runtime-injected base URL and API key.
- Linked the new guide from the “Write your first AgentApp” tutorial and the AgentApp runtime explanation.
- Clarified in the docs index that the Open Responses-compatible endpoint is internal (not a public external API).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| agent/docs/source/tutorials/write-your-first-agentapp.md | Adds a link directing readers to the new OpenAI SDK how-to guide. |
| agent/docs/source/index.md | Adds the new guide to the docs and clarifies endpoint scope (internal vs public). |
| agent/docs/source/how-to-guides/use-openai-sdk.md | New how-to guide describing how to use the OpenAI Python SDK against Flower’s internal runtime endpoint. |
| agent/docs/source/explanations/agentapp-runtime.md | Adds a reference to the new how-to guide for SDK usage. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| Create the client inside the main function so commands such as `flwr build` can | ||
| import the module without requiring a running Flower runtime: | ||
|
|
Comment on lines
+9
to
+10
| AgentApp](../tutorials/write-your-first-agentapp.md). This guide targets Flower | ||
| 1.34.0. |
Comment on lines
+31
to
+35
| - `FLWR_RUNTIME_BASE_URL` is the base URL of the internal Runtime API | ||
| - `FLWR_RUNTIME_API_KEY` authenticates requests from the AgentApp process | ||
|
|
||
| Pass both values to `OpenAI` without modifying them. The SDK adds the | ||
| `/responses` path when it creates a response. |
github-actions
Bot
added
the
Maintainer
6 tasks
danieljanes
force-pushed
the
docs/agent-open-responses
branch
from
August 21, 2026 13:25
f930941 to
c8bc5ef
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
Description
Related issues/PRs
Proposal
Explanation
Checklist
#contributions)Any other comments?