Add WebSocket transport documentation for Sandbox SDK #26764
+68
−3
Conversation
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
agents-git-bot
bot
requested review from
a team and
whoiskatrin
as code owners
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
agents-git-bot
bot
force-pushed
the
sync-docs-pr-253
branch
from
0590f6d to
f1f7c5f
Compare
Documents the new WebSocket transport mode introduced in PR #253. This feature allows multiplexing all SDK requests over a single WebSocket connection, reducing sub-request count in Workers/DOs. Changes: - Add transportMode configuration option in sandbox-options.mdx - Document HTTP vs WebSocket modes with usage examples - Add "When to use transportMode" guidance section - Update architecture diagram to show WebSocket as transport option - Add transport modes explanation in architecture concepts 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
agents-git-bot
bot
force-pushed
the
sync-docs-pr-253
branch
from
f1f7c5f to
65ba003
Compare
agents-git-bot
bot
changed the title
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
Documents the new WebSocket transport feature for the Cloudflare Sandbox SDK introduced in cloudflare/sandbox-sdk#253.
This PR adds documentation for the WebSocket transport mode, which allows multiplexing all SDK requests over a single persistent WebSocket connection. This reduces sub-request count when running inside Workers/Durable Objects.
Changes
Sandbox options (
/sandbox/configuration/sandbox-options/):transportModeconfiguration option with HTTP and WebSocket modesArchitecture concepts (
/sandbox/concepts/architecture/):Why this matters
When making many SDK operations in quick succession, the default HTTP transport can hit Worker sub-request limits (1000 per request in free tier). WebSocket transport solves this by multiplexing all operations over a single connection, significantly reducing sub-request count.
Related PR
🤖 Generated with Claude Code