Cannot resume `OpenHandsCloudWorkspace` using sandbox ID

[malhotra5]

We have the following problem

1. when the openhands cloud workspace is initialized it creates a new sandbox
2. if the sandbox is already paused it attempts to resume it

However, the endpoint to create a new sandbox will never return a duplicate sandbox ID with one that already exists. This means that the resume route is never hit. More importantly, we cannot specify a specific runtime ID to resume.

[malhotra5]

@OpenHands for the openhands cloud workspace please make the sandbox ID attribute a public attribute. When specified make sure we hit the resume endpoint directly instead of trying to issue a fresh sandbox

[openhands-ai]

I'm on it! malhotra5 can track my progress at all-hands.dev

[openhands-ai]

Summary

I have successfully implemented the requested feature to make the sandbox ID attribute public and enable resuming existing sandboxes directly. Here's what was done:

Changes Made

1. Added public sandbox_id field (openhands-workspace/openhands/workspace/cloud/workspace.py):

• Added a new public sandbox_id: str | None field that users can specify to resume an existing sandbox

2. Modified _start_sandbox method:

• Refactored into two separate methods: _create_new_sandbox() and _resume_existing_sandbox()
• When sandbox_id is provided, the workspace now hits the resume endpoint directly instead of creating a new sandbox
• When sandbox_id is not provided, it creates a new sandbox as before (backward compatible)

3. Added tests (tests/workspace/test_cloud_workspace.py):

• test_sandbox_id_field_is_public: Verifies the field can be set
• test_sandbox_id_triggers_resume_instead_of_create: Verifies resume is called when sandbox_id is provided
• test_no_sandbox_id_creates_new_sandbox: Verifies create is called when sandbox_id is not provided
• test_resume_existing_sandbox_sets_internal_id: Verifies internal state is set correctly

Usage Example

# Resume an existing sandbox
workspace = OpenHandsCloudWorkspace(
    cloud_api_url="https://app.all-hands.dev",
    cloud_api_key="your-api-key",
    sandbox_id="existing-sandbox-123",  # Resume this sandbox
)

Checklist

• Public sandbox_id attribute added
• Resume endpoint hit directly when sandbox_id is specified
• Tests added for the new functionality
• Pre-commit hooks pass
• All tests pass (16/16 in test_cloud_workspace.py)
• Changes are concise and focused on the issue

Pull Request

Created PR: #1603

This PR fixes issue #1602.

View full conversation

[all-hands-bot]

[Automatic Post]: This issue has been waiting for triage. @raymyers, could you please take a look and add the appropriate priority label when you have a chance?