Skip to content

Add warning to API-based Sandbox page about production use #475

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.

Sign up for GitHub

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
xingyaoww merged 4 commits into from
Apr 25, 2026
Merged

Add warning to API-based Sandbox page about production use #475

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3042340
Add warning to API-based Sandbox page about production use
openhands-agent Apr 24, 2026
5827186
Update sdk/guides/agent-server/api-sandbox.mdx
xingyaoww Apr 24, 2026
906ccec
Apply suggestion from @xingyaoww
xingyaoww Apr 24, 2026
a757ca0
Update sdk/guides/agent-server/api-sandbox.mdx
xingyaoww Apr 25, 2026
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
3 changes: 3 additions & 0 deletions sdk/guides/agent-server/api-sandbox.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@

> A ready-to-run example is available [here](#ready-to-run-example)!

<Warning>
The [Runtime API](https://runtime.all-hands.dev/) (`runtime.all-hands.dev`) is designed primarily for **[benchmark evaluation at scale](https://github.com/OpenHands/benchmarks)**, not for building production applications. If you are building a production application with the SDK, use the **[OpenHands Cloud Workspace](/sdk/guides/agent-server/cloud-workspace)** instead, which provides fully managed sandbox environments with SaaS credential support.
</Warning>

The API-sandboxed agent server demonstrates how to use `APIRemoteWorkspace` to connect to a [OpenHands runtime API service](https://runtime.all-hands.dev/). This eliminates the need to manage your own infrastructure, providing automatic scaling, monitoring, and secure sandboxed execution.

Check warning on line 12 in sdk/guides/agent-server/api-sandbox.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

sdk/guides/agent-server/api-sandbox.mdx#L12 

Did you really mean 'sandboxed'?

## Key Concepts

Expand All @@ -24,7 +27,7 @@

This workspace type:
- Connects to a remote runtime API service
- Automatically provisions sandboxed environments

Check warning on line 30 in sdk/guides/agent-server/api-sandbox.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

sdk/guides/agent-server/api-sandbox.mdx#L30 

Did you really mean 'sandboxed'?
- Manages container lifecycle through the API
- Handles all infrastructure concerns

Expand Down
Loading