You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: rename saas_runtime_mode to local_agent_server_mode
Update all references to match the rename in software-agent-sdk PR #2490:
- Rename parameter: saas_runtime_mode -> local_agent_server_mode
- Rename section heading: SaaS Runtime Mode -> Local Agent Server Mode
- Rename SVG files to match new naming
- Move automation_callback_url and automation_run_id to env vars table
- Update code examples to remove constructor args that are now env vars
Co-authored-by: openhands <openhands@all-hands.dev>
Copy file name to clipboardExpand all lines: sdk/guides/agent-server/cloud-workspace.mdx
+16-18Lines changed: 16 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -383,14 +383,14 @@ cd agent-sdk
383
383
uv run python examples/02_remote_agent_server/10_cloud_workspace_share_credentials.py
384
384
```
385
385
386
-
## SaaS Runtime Mode
386
+
## Local Agent Server Mode
387
387
388
-
Use `saas_runtime_mode=True` when your SDK script is **already running inside** an OpenHands Cloud sandbox — for example, as part of an automation workflow deployed to the cloud.
388
+
Use `local_agent_server_mode=True` when your SDK script is **already running inside** an OpenHands Cloud sandbox — for example, as part of an automation workflow deployed to the cloud.
389
389
390
390
### When to Use This Mode
391
391
392
-
| Scenario | Normal Mode |SaaS Runtime Mode |
393
-
|----------|-------------|-------------------|
392
+
| Scenario | Normal Mode |Local Agent Server Mode |
3. The script uses `saas_runtime_mode=True` to connect to the local agent-server
491
+
3. The script uses `local_agent_server_mode=True` to connect to the local agent-server
494
492
495
493
4.**Receive callback** when the script completes (optional)
496
494
497
495
This pattern enables fire-and-forget automation where your orchestrator doesn't need to maintain a connection for the entire agent session.
498
496
499
497
<Note>
500
-
SaaS runtime mode is primarily used by the OpenHands automation service. For most SDK users, normal mode with `get_llm()` and `get_secrets()` provides a simpler experience.
498
+
Local agent server mode is primarily used by the OpenHands automation service. For most SDK users, normal mode with `get_llm()` and `get_secrets()` provides a simpler experience.
Copy file name to clipboardExpand all lines: sdk/guides/agent-server/workspace-types.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -112,10 +112,10 @@ For advanced orchestration, you may want to run SDK scripts *inside* a Cloud san
112
112
- You need **nested agent execution** — an outer agent spawns inner agents
113
113
- You're building an **automation service** that deploys user-provided scripts
114
114
115
-
This uses `saas_runtime_mode=True`. See [SaaS Runtime Mode](/sdk/guides/agent-server/cloud-workspace#saas-runtime-mode) for the full pattern.
115
+
This uses `local_agent_server_mode=True`. See [Local Agent Server Mode](/sdk/guides/agent-server/cloud-workspace#local-agent-server-mode) for the full pattern.
0 commit comments