Skip to content

docs(sdk): orchestrate conversations through existing workspace APIs - #793

Draft
neubig wants to merge 10 commits into
mainfrom
feat/agent-server-python-client
Draft

docs(sdk): orchestrate conversations through existing workspace APIs#793
neubig wants to merge 10 commits into
mainfrom
feat/agent-server-python-client

Conversation

@neubig

@neubig neubig commented Sep 12, 2026

Copy link
Copy Markdown
Member

Closes #792. Document orchestration through RemoteConversation and RemoteWorkspace: explicit server-side creation with a typed StartConversationRequest, explicit attachment to an existing conversation, title updates, scoped file/command operations, optional asynchronous workspace calls, and runtime credential/lifecycle ownership.

SDK #5010 adds the explicit create/attach methods and scoped workspace operations. Creation sends the canonical request; attachment fetches existing state and never falls back to creation. This guide introduces no separate control-client layer. Publish with that SDK release and Automation profile dispatch. Worker code stays identical in local and Docker workspaces; the dispatcher selects paths and runtime credentials.

Validation: all three Python snippets parse. Live Canvas evidence runs exact Python fences 1 and 2 from this guide revision unchanged: explicit profile creation, title update, byte upload, and the async helper reading the uploaded file with exit 0. A bounded worker using the documented explicit-attachment API also completes a real model task identically in local and Docker workspaces; its task prompt differs from fence 3. The report includes the GIF, screenshots, exact source hashes, and the initial HTTP 500 corrected in SDK4bbab2dd0 without an example-side workaround. It supersedes the historical ordinary-constructor recording.

  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

@mintlify

mintlify Bot commented Sep 12, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
all-hands-ai 🟢 Ready View Preview Sep 13, 2026, 9:28 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@neubig neubig changed the title Document public Agent Server orchestration clients docs(sdk): document public Agent Server orchestration clients Sep 12, 2026
Co-authored-by: openhands <openhands@all-hands.dev>
@neubig neubig changed the title docs(sdk): document public Agent Server orchestration clients docs(sdk): orchestrate conversations through existing workspace APIs Sep 13, 2026
@neubig
neubig requested review from all-hands-bot and removed request for all-hands-bot September 13, 2026 20:29
Co-authored-by: openhands <openhands@all-hands.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Agent Server orchestration clients and workspace-independent automation

2 participants