Health check

bearerAuth

All Hands Docs

Introduction

Running OpenHands on the cloud or your local desktop

Quick Start

So you've [run OpenHands](./installation) and have [set up your LLM](./installation#setup). Now what?

Start Building

Key Features

Getting Started

The Cloud UI provides a web interface for interacting with OpenHands AI. This page explains how to access and use the OpenHands Cloud UI.

Cloud UI

The Cloud Issue Resolver automates code fixes and provides intelligent assistance for your repositories on GitHub.

Cloud Issue Resolver

OpenHands Cloud provides a REST API that allows you to programmatically interact with the service. This guide explains how to obtain an API key and use the API to start conversations.

Cloud API

OpenHands provides a Graphical User Interface (GUI) mode for interacting with the AI assistant.

GUI Mode

CLI mode provides a powerful interactive Command-Line Interface (CLI) that lets you engage with OpenHands directly from your terminal.

CLI Mode

You can run OpenHands with a single command, without starting the web application. This makes it easy to write scripts and automate tasks with OpenHands.

Headless Mode

This guide explains how to use the OpenHands GitHub Action in your own projects.

OpenHands GitHub Action

When working with OpenHands AI software developer, providing clear and effective prompts is key to getting accurate and useful responses. This guide outlines best practices for crafting effective prompts.

Prompting Best Practices

You can customize how OpenHands interacts with your repository by creating a `.openhands` directory at the root level.

Repository Customization

Microagents are specialized prompts that enhance OpenHands with domain-specific knowledge. They provide expert guidance, automate common tasks, and ensure consistent practices across projects.

Microagents Overview

General guidelines for OpenHands to work more effectively with the repository.

General Microagents

Keyword-triggered microagents provide OpenHands with specific instructions that are activated when certain keywords appear in the prompt. This is useful for tailoring behavior based on particular tools, languages, or frameworks.

Keyword-Triggered Microagents

Organizations and users can define microagents that apply to all repositories belonging to the organization or user.

Organization and User Microagents

Global microagents are [keyword-triggered microagents](./microagents-keyword) that apply to all OpenHands users. A list of the current global microagents can be found [in the OpenHands repository](https://github.com/All-Hands-AI/OpenHands/tree/main/microagents).

Global Microagents

OpenHands can connect to any LLM supported by LiteLLM. However, it requires a powerful model to work.

Overview

This section is for users that would like to use a runtime other than Docker for OpenHands.

This page outlines all available configuration options for OpenHands, allowing you to customize its behavior and integrate it with other services. In GUI Mode, any settings applied through the Settings UI will take precedence.

Configuration Options

This guide is for users that would like to use their own custom Docker image for the runtime. For example, with certain tools or programming languages pre-installed.

Custom Sandbox

This page outlines how to configure and use the Model Context Protocol (MCP) in OpenHands, allowing you to extend the agent's capabilities with custom tools.

Model Context Protocol (MCP)

Troubleshooting

This guide provides an overview of the key documentation resources available in the OpenHands repository. Whether you're looking to contribute, understand the architecture, or work on specific components, these resources will help you navigate the codebase effectively.

Development Overview

Backend Architecture

Runtime Architecture

Debugging

Evaluation Harness

WebSocket Connection

Retrieve the runtime configuration (session ID and runtime ID)

Get runtime configuration

Get VSCode URL

Get runtime hosts

Submit feedback

List files

Get file content

Download the current workspace as a zip file

Download workspace as zip

Get git changes

Get git diff

Get trajectory

Catch-all route for security analyzer API GET requests

Security analyzer API (GET)

Catch-all route for security analyzer API PUT requests

Security analyzer API (PUT)

Catch-all route for security analyzer API POST requests

Security analyzer API (POST)

Catch-all route for security analyzer API DELETE requests

Security analyzer API (DELETE)

Search conversations

Create new conversation

Get conversation

Delete conversation

Update conversation

Get repositories for the authenticated user

Get user repositories

Get information about the authenticated user

Get user info

Search repositories

Get suggested tasks for the authenticated user across their most recently pushed repositories

Get suggested tasks

Get settings

Store settings

This endpoint is deprecated and will return a 410 Gone error. Reset functionality has been removed.

API Reference

Health check

Authorizations

Response