From 436790d256dc17462abc0eeb89cb1f67bf278f65 Mon Sep 17 00:00:00 2001 From: openhands Date: Sat, 14 Mar 2026 01:56:08 +0000 Subject: [PATCH] docs(sdk): document new public exports Co-authored-by: openhands --- sdk/api-reference/openhands.sdk.llm.mdx | 11 +++++++++++ sdk/api-reference/openhands.sdk.utils.mdx | 15 +++++++++++++++ sdk/api-reference/openhands.sdk.workspace.mdx | 11 +++++++++++ 3 files changed, 37 insertions(+) diff --git a/sdk/api-reference/openhands.sdk.llm.mdx b/sdk/api-reference/openhands.sdk.llm.mdx index 4e6f8a90f..59d4150f2 100644 --- a/sdk/api-reference/openhands.sdk.llm.mdx +++ b/sdk/api-reference/openhands.sdk.llm.mdx @@ -4,6 +4,17 @@ description: API reference for openhands.sdk.llm module --- +## Import shortcuts + +`TokenUsage` is part of the public LLM metrics surface and can be imported from either `openhands.sdk.llm` or the top-level `openhands.sdk` package. + +```python +from openhands.sdk.llm import TokenUsage +# or +from openhands.sdk import TokenUsage +``` + + ### class CredentialStore Bases: `object` diff --git a/sdk/api-reference/openhands.sdk.utils.mdx b/sdk/api-reference/openhands.sdk.utils.mdx index 237164e09..bdafd5218 100644 --- a/sdk/api-reference/openhands.sdk.utils.mdx +++ b/sdk/api-reference/openhands.sdk.utils.mdx @@ -6,6 +6,21 @@ description: API reference for openhands.sdk.utils module Utility functions for the OpenHands SDK. + +## Import shortcuts + +`page_iterator` is publicly exported from `openhands.sdk.utils` and from the top-level `openhands.sdk` package. + +```python +from openhands.sdk.utils import page_iterator +# or +from openhands.sdk import page_iterator +``` + +### page_iterator() + +Iterate over items from paginated search results. + ### deprecated() Return a decorator that deprecates a callable with explicit metadata. diff --git a/sdk/api-reference/openhands.sdk.workspace.mdx b/sdk/api-reference/openhands.sdk.workspace.mdx index 480666553..c77230e70 100644 --- a/sdk/api-reference/openhands.sdk.workspace.mdx +++ b/sdk/api-reference/openhands.sdk.workspace.mdx @@ -4,6 +4,17 @@ description: API reference for openhands.sdk.workspace module --- +## Import shortcuts + +`AsyncRemoteWorkspace` is publicly exported from `openhands.sdk.workspace.remote`, `openhands.sdk.workspace`, and the top-level `openhands.sdk` package. + +```python +from openhands.sdk.workspace import AsyncRemoteWorkspace +# or +from openhands.sdk import AsyncRemoteWorkspace +``` + + ### class BaseWorkspace Bases: `DiscriminatedUnionMixin`, `ABC`