docs: explain SDK browser conversation event streams - #795
Draft
neubig wants to merge 2 commits into
Draft
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This was referenced Sep 12, 2026
Draft
neubig
requested review from
all-hands-bot
and removed request for
all-hands-bot
September 13, 2026 02:45
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
2 participants
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.
Summary of changes
Document the SDK-owned browser conversation event stream, including authentication, replay, reconnects, lifecycle callbacks, cleanup, and REST fallback. Add navigation and overview links. Mark the API unreleased so this guide ships with its SDK release.
Fixes #794. SDK implementation: OpenHands/software-agent-sdk#5013; Canvas consumer: OpenHands/OpenHands#17389.
Validation: JSON navigation parses and git diff whitespace checks pass. The client example's authentication and reconnect behavior was exercised against the isolated Agent Server. Mintlify rendering/link checks will run on this PR; no local docs preview was run.