docs: Add section on launching one-off tasks via Cloud API#319
Draft
docs: Add section on launching one-off tasks via Cloud API#319
Conversation
Added a new section to the cloud-workspace guide explaining how to use the OpenHands Cloud API directly for launching asynchronous tasks. This is useful for CI/CD workflows where you want to start a task and exit immediately. Key additions: - Introduction updated to mention both approaches (OpenHandsCloudWorkspace vs Cloud API Direct) - New 'Launching One-Off Tasks via Cloud API' section with: - Comparison table of both approaches - Explanation of how Cloud API uses account-configured LLM and GitHub credentials - Python code example showing how to start a conversation via the API - GitHub Actions example using the PR Review workflow - Decision guide for when to use each approach - Added link to PR Review workflow in Next Steps This documents the cloud mode feature added in PR #1966 of software-agent-sdk. Co-authored-by: openhands <openhands@all-hands.dev>
5 tasks
Updated both PR review documentation pages to include the new cloud mode option: 1. sdk/guides/github-workflows/pr-review.mdx: - Added 'Review Modes' section explaining SDK vs Cloud modes - Added tabs in Quick Start for SDK and Cloud mode setup - Updated Action Inputs table with cloud mode options - Added Cloud Mode Workflow Example with complete YAML 2. openhands/usage/use-cases/code-review.mdx: - Added 'Review Modes' section with comparison table - Added 'Cloud Mode Benefits' subsection - Added tabs in Quick Start for SDK and Cloud mode workflows - Updated Action Inputs table with cloud mode options - Added link to Cloud Workspace Guide in Related Resources Cloud mode benefits: - Only needs OPENHANDS_CLOUD_API_KEY (no LLM_API_KEY or GITHUB_TOKEN) - Uses cloud-configured LLM and GitHub credentials - Workflow exits immediately; review runs asynchronously - Track progress via conversation URL in OpenHands Cloud UI Co-authored-by: openhands <openhands@all-hands.dev>
Updated all references to getting an OpenHands Cloud API key to point to the official documentation page: /openhands/usage/cloud/cloud-api#obtaining-an-api-key This provides a single source of truth for API key instructions. Co-authored-by: openhands <openhands@all-hands.dev>
Cloud mode needs GITHUB_TOKEN to post initial comment with conversation URL. Changes: - Updated Review Modes tables to show GITHUB_TOKEN required for both - Updated cloud mode workflow examples to include github-token - Updated Action Inputs tables Co-authored-by: openhands <openhands@all-hands.dev>
The OpenHands Cloud account must have GitHub access to the target repository. Added warning and link to GitHub Installation Guide in both PR review docs. Co-authored-by: openhands <openhands@all-hands.dev>
Updated documentation to reflect the refactored cloud mode: - Both modes use the same Agent, LLM, and Conversation pattern - The only difference is the workspace type (local vs OpenHandsCloudWorkspace) - Both modes require LLM_API_KEY since LLM config is sent to cloud sandbox - Removed outdated 'Cloud API Direct' documentation Co-authored-by: openhands <openhands@all-hands.dev>
Cloud mode uses /api/conversations endpoint which doesn't require LLM_API_KEY - it uses the user's cloud-configured LLM. Co-authored-by: openhands <openhands@all-hands.dev>
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
2 participants
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
This PR adds documentation for the new cloud mode feature in the PR Review workflow, which allows launching code reviews via the OpenHands Cloud API.
Related PR
This documents the cloud mode feature added in software-agent-sdk PR #1966.
Files Changed
1.
sdk/guides/agent-server/cloud-workspace.mdx2.
sdk/guides/github-workflows/pr-review.mdx3.
openhands/usage/use-cases/code-review.mdxCloud Mode Benefits Documented
LLM_API_KEYGITHUB_TOKENLLM_API_KEY,GITHUB_TOKENOPENHANDS_CLOUD_API_KEYonlyPreview