docs: add /launch feature documentation to API v1

[jpelletier1]

• 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.

Summary of changes

Added documentation for the /launch feature to the API v1 documentation page under a new Use Cases section titled "Start Conversations from Plugins".

The /launch feature enables users to specify a plugin location from a remote repository (e.g., GitHub) and an initial message to run within OpenHands Cloud.

What's included:

• New "Use Cases" section in openhands/usage/api/v1.mdx
• Documentation of URL formats:
  • Production format: Base64-encoded JSON
  • Simple format: Query parameters
• Complete PluginSpec structure with all fields:
  • source (required): Plugin source location
  • ref (optional): Branch, tag, or commit reference
  • repo_path (optional): Subdirectory path within repository
  • parameters (optional): User-provided configuration values
• Example usage demonstrating the feature

This documentation supports the /launch feature implemented in OpenHands/OpenHands#12699.

@jpelletier1 can click here to continue refining the PR

[all-hands-bot]

🟡 Acceptable - Documentation accurately describes the /launch feature with verified PluginSpec structure. Minor improvement needed for completeness.

[all-hands-bot]

🟠 Important: The simple format documentation is missing the plugin_repo_path parameter.

The code supports this parameter (see launch.tsx line 73):

repo_path: searchParams.get("plugin_repo_path") ?? null,

Suggested change

	- **URL format (simple)**: <code>/launch?plugin_source=github:owner/repo&plugin_ref=v1.0.0</code>
	- **URL format (simple)**: <code>/launch?plugin_source=github:owner/repo&plugin_ref=v1.0.0&plugin_repo_path=subdirectory</code>

[all-hands-bot]

🟡 Suggestion: Consider using proper code blocks instead of inline <code> tags for the URL examples to improve readability:

**Production format:**

/launch?plugins=BASE64_ENCODED_JSON&message=Optional%20message

**Simple format:**

/launch?plugin_source=github:owner/repo&plugin_ref=v1.0.0

**Example:**

/launch?plugins=W3sic291cmNlIjoiZ2l0aHViOm9wZW5oYW5kcy9leGFtcGxlLXBsdWdpbiIsInJlZiI6InYxLjAuMCJ9XQ==&message=Analyze%20this%20codebase

This makes the URLs easier to copy and test.

[jpelletier1]

@OpenHands add message as an optional parameter to the pluginspec. Also, make sure the example cites app.all-hands.dev/launch

[mintlify]

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

Project	Status	Preview	Updated (UTC)
all-hands-ai	🟢 Ready	View Preview	Apr 6, 2026, 6:33 PM

[openhands-ai]

I'm on it! jpelletier1 can track my progress at all-hands.dev

[jpelletier1]

✅ Done! I've updated the documentation:

1. Added message as an optional parameter in the PluginSpec structure
2. Updated all example URLs to use app.all-hands.dev/launch

Changes pushed in commit bd29d7c.

Note: There are also 2 review comments on the PR that suggest:

• Adding plugin_repo_path to the simple format documentation
• Using proper code blocks instead of inline <code> tags

Let me know if you'd like me to address those as well!

[openhands-ai]

Summary of Work Completed

I've successfully addressed the PR comment requesting updates to the /launch feature documentation:

✅ Request Checklist

1. Add message as optional parameter to PluginSpec - ✅ Complete

   • Added: message (string, optional): Initial message to run with the plugin

2. Update examples to cite app.all-hands.dev/launch - ✅ Complete

   • Updated production format URL
   • Updated simple format URL
   • Updated example URL

Changes Made

All changes were concise and directly addressed the request:

• File modified: openhands/usage/api/v1.mdx
• Lines changed: 4 insertions, 3 deletions
• Commit: bd29d7c - "docs: add message parameter to PluginSpec and update example URLs"
• Status: Pushed to docs/add-launch-feature-documentation branch

Additional Information

I also identified 2 existing review comments on the PR suggesting:

• Adding plugin_repo_path parameter to simple format
• Using code blocks instead of inline <code> tags

These were noted in my PR comment for your consideration but not implemented as they weren't part of the current request.

PR Link: #438