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: fix agent-server Client SDK section with actual API (OpenHands#496)
* docs: fix agent-server Client SDK section with actual API
Replace non-existent AgentServerClient documentation with actual SDK usage.
The previous documentation referenced a 'Client SDK' with AgentServerClient
class that does not exist. This update replaces it with:
- OpenHandsCloudWorkspace for OpenHands Cloud integration
- APIRemoteWorkspace for custom runtime environments
- RemoteConversation which is the actual API for remote agent execution
FixesOpenHands#495
Co-authored-by: openhands <openhands@all-hands.dev>
* docs: refactor to architecture-focused content per review feedback
- Replace usage examples with architecture diagram and pattern explanation
- Add workspace types table showing dispatch behavior
- Document RemoteConversation responsibilities
- Link to existing guides for complete working examples
Addresses review feedback about architecture docs focusing on design
patterns rather than tutorial-style usage instructions.
Co-authored-by: openhands <openhands@all-hands.dev>
* docs: add GitHub source links to component names
Per sdk-arch-guidelines.md, link every component name to its source file.
Co-authored-by: openhands <openhands@all-hands.dev>
---------
Co-authored-by: openhands <openhands@all-hands.dev>
The SDK implements a **workspace-based dispatch pattern**for connecting to agent servers. The `Conversation` factory inspects the workspace type and returns the appropriate conversation implementation.
style Server fill:#fff4df,stroke:#b7791f,stroke-width:2px
385
+
```
377
386
378
-
client = AgentServerClient(
379
-
url="https://agent-server.example.com",
380
-
api_key="your-api-key"
381
-
)
387
+
### Workspace Types
382
388
383
-
# Create conversation
384
-
conversation = client.create_conversation()
389
+
| Workspace | Conversation Type | Communication |
390
+
|-----------|------------------|---------------|
391
+
|[`LocalWorkspace`](https://github.com/OpenHands/software-agent-sdk/blob/main/openhands-sdk/openhands/sdk/workspace/local.py)|[`LocalConversation`](https://github.com/OpenHands/software-agent-sdk/blob/main/openhands-sdk/openhands/sdk/conversation/impl/local_conversation.py)| Direct execution |
392
+
|[`OpenHandsCloudWorkspace`](https://github.com/OpenHands/software-agent-sdk/blob/main/openhands-workspace/openhands/workspace/cloud/workspace.py)|[`RemoteConversation`](https://github.com/OpenHands/software-agent-sdk/blob/main/openhands-sdk/openhands/sdk/conversation/impl/remote_conversation.py)| HTTPS + WebSocket to OpenHands Cloud |
393
+
|[`APIRemoteWorkspace`](https://github.com/OpenHands/software-agent-sdk/blob/main/openhands-workspace/openhands/workspace/remote_api/workspace.py)|[`RemoteConversation`](https://github.com/OpenHands/software-agent-sdk/blob/main/openhands-sdk/openhands/sdk/conversation/impl/remote_conversation.py)| HTTPS + WebSocket to Runtime API |
394
+
|[`DockerWorkspace`](https://github.com/OpenHands/software-agent-sdk/blob/main/openhands-workspace/openhands/workspace/docker/workspace.py)|[`RemoteConversation`](https://github.com/OpenHands/software-agent-sdk/blob/main/openhands-sdk/openhands/sdk/conversation/impl/remote_conversation.py)| HTTP + WebSocket to local container |
0 commit comments