Export TokenUsage, page_iterator, and AsyncRemoteWorkspace as public SDK APIs#2445
Merged
Export TokenUsage, page_iterator, and AsyncRemoteWorkspace as public SDK APIs#2445
Conversation
Co-authored-by: openhands <openhands@all-hands.dev>
2 tasks
Contributor
Python API breakage checks — ✅ PASSEDResult: ✅ PASSED |
Contributor
REST API breakage checks (OpenAPI) — ❌ FAILEDResult: ❌ FAILED
Log excerpt (first 1000 characters) |
Contributor
enyst
commented
Mar 14, 2026
Co-authored-by: openhands <openhands@all-hands.dev>
all-hands-bot
approved these changes
Mar 14, 2026
Collaborator
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste
Simple, pragmatic fix. Promoting already-used symbols to public API eliminates deep imports without adding complexity or breaking anything. This is exactly what API surface management should look like.
VERDICT: ✅ Worth merging - Clean additive change solving a real problem.
KEY INSIGHT: Best kind of API change - makes existing usage cleaner without touching any logic.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Promote a few symbols that OpenHands already relies on into package public APIs:
TokenUsagepage_iteratorAsyncRemoteWorkspaceThis updates package exports so consumers can import these from curated
__init__.pyAPIs instead of deep implementation modules.Docs PR: OpenHands/docs#394
Checklist
Fixes #2444
Agent Server images for this PR
• GHCR package: https://github.com/OpenHands/agent-sdk/pkgs/container/agent-server
Variants & Base Images
eclipse-temurin:17-jdknikolaik/python-nodejs:python3.13-nodejs22golang:1.21-bookwormPull (multi-arch manifest)
# Each variant is a multi-arch manifest supporting both amd64 and arm64 docker pull ghcr.io/openhands/agent-server:1209c18-pythonRun
All tags pushed for this build
About Multi-Architecture Support
1209c18-python) is a multi-arch manifest supporting both amd64 and arm641209c18-python-amd64) are also available if needed