# OpenHands Docs

## Docs

- [Introduction](https://allhandsai-sdk-docs.mintlify.site/index.md): OpenHands - Code Less, Make More.
- [Quick Start](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/quick-start.md): Running OpenHands Cloud or running on your own.
- [Start Building](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/start-building.md): So you've [run OpenHands](/openhands/usage/quick-start). Now what?
- [Key Features](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/key-features.md)
- [FAQs](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/faqs.md): Frequently asked questions about OpenHands.
- [Getting Started](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/openhands-cloud.md): Getting started with OpenHands Cloud.
- [Pro Subscription](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/pro-subscription.md): Learn about OpenHands Cloud Pro Subscription features and pricing.
- [Bitbucket Integration](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/bitbucket-installation.md): This guide walks you through the process of installing OpenHands Cloud for your Bitbucket repositories. Once set up, it will allow OpenHands to work with your Bitbucket repository.
- [GitHub Integration](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/github-installation.md): This guide walks you through the process of installing OpenHands Cloud for your GitHub repositories. Once set up, it will allow OpenHands to work with your GitHub repository through the Cloud UI or straight from GitHub!
- [GitLab Integration](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/gitlab-installation.md): This guide walks you through the process of installing OpenHands Cloud for your GitLab repositories. Once set up, it will allow OpenHands to work with your GitLab repository through the Cloud UI or straight from GitLab!.
- [Slack Integration (Beta)](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/slack-installation.md): This guide walks you through installing the OpenHands Slack app.
- [Project Management Tool Integrations (Coming soon...)](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/project-management/overview.md): Overview of OpenHands Cloud integrations with project management platforms including Jira Cloud, Jira Data Center, and Linear. Learn about setup requirements, usage methods, and troubleshooting.
- [Jira Cloud Integration (Coming soon...)](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/project-management/jira-integration.md): Complete guide for setting up Jira Cloud integration with OpenHands Cloud, including service account creation, API token generation, webhook configuration, and workspace integration setup.
- [Jira Data Center Integration (Coming soon...)](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/project-management/jira-dc-integration.md): Complete guide for setting up Jira Data Center integration with OpenHands Cloud, including service account creation, personal access token generation, webhook configuration, and workspace integration setup.
- [Linear Integration (Coming soon...)](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/project-management/linear-integration.md): Complete guide for setting up Linear integration with OpenHands Cloud, including service account creation, API key generation, webhook configuration, and workspace integration setup.
- [Cloud UI](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/cloud-ui.md): The Cloud UI provides a web interface for interacting with OpenHands. This page provides references on how to use the OpenHands Cloud UI.
- [Cloud API](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/cloud/cloud-api.md): OpenHands Cloud provides a REST API that allows you to programmatically interact with OpenHands. This guide explains how to obtain an API key and use the API to start conversations and retrieve their status.
- [Getting Started](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/run-openhands/local-setup.md): Getting started with running OpenHands on your own.
- [GUI](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/run-openhands/gui-mode.md): High level overview of the Graphical User Interface (GUI) in OpenHands.
- [CLI](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/run-openhands/cli-mode.md): The Command-Line Interface (CLI) provides a powerful interface that lets you engage with OpenHands directly from your terminal.
- [Headless](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/run-openhands/headless-mode.md): 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.
- [OpenHands GitHub Action](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/run-openhands/github-action.md): This guide explains how to use the OpenHands GitHub Action in your own projects.
- [Overview](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/llms/llms.md): OpenHands can connect to any LLM supported by LiteLLM. However, it requires a powerful model to work.
- [OpenHands](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/llms/openhands-llms.md): OpenHands LLM provider with access to state-of-the-art (SOTA) agentic coding models.
- [Azure](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/llms/azure-llms.md): OpenHands uses LiteLLM to make calls to Azure's chat models. You can find their documentation on using Azure as a provider [here](https://docs.litellm.ai/docs/providers/azure).
- [Google Gemini/Vertex](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/llms/google-llms.md): OpenHands uses LiteLLM to make calls to Google's chat models. You can find their documentation on using Google as a provider -> [Gemini - Google AI Studio](https://docs.litellm.ai/docs/providers/gemini), [VertexAI - Google Cloud Platform](https://docs.litellm.ai/docs/providers/vertex)
- [Groq](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/llms/groq.md): OpenHands uses LiteLLM to make calls to chat models on Groq. You can find their documentation on using Groq as a provider [here](https://docs.litellm.ai/docs/providers/groq).
- [Local LLMs](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/llms/local-llms.md): When using a Local LLM, OpenHands may have limited functionality. It is highly recommended that you use GPUs to serve local models for optimal experience.
- [LiteLLM Proxy](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/llms/litellm-proxy.md): OpenHands supports using the [LiteLLM proxy](https://docs.litellm.ai/docs/proxy/quick_start) to access various LLM providers.
- [Moonshot AI](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/llms/moonshot.md): How to use Moonshot AI models with OpenHands
- [OpenAI](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/llms/openai-llms.md): OpenHands uses LiteLLM to make calls to OpenAI's chat models. You can find their documentation on using OpenAI as a provider [here](https://docs.litellm.ai/docs/providers/openai).
- [OpenRouter](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/llms/openrouter.md): OpenHands uses LiteLLM to make calls to chat models on OpenRouter. You can find their documentation on using OpenRouter as a provider [here](https://docs.litellm.ai/docs/providers/openrouter).
- [Overview](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/runtimes/overview.md): This section is for users that would like to use a runtime other than Docker for OpenHands.
- [Docker Runtime](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/runtimes/docker.md): This is the default Runtime that's used when you start OpenHands.
- [Remote Runtime](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/runtimes/remote.md): This runtime is specifically designed for agent evaluation purposes only through the [OpenHands evaluation harness](https://github.com/All-Hands-AI/OpenHands/tree/main/evaluation). It should not be used to launch production OpenHands applications.
- [Local Runtime](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/runtimes/local.md): The Local Runtime allows the OpenHands agent to execute actions directly on your local machine without using Docker. This runtime is primarily intended for controlled environments like CI pipelines or testing scenarios where Docker is not available.
- [Modal Runtime](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/runtimes/modal.md)
- [Daytona Runtime](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/runtimes/daytona.md): You can use [Daytona](https://www.daytona.io/) as a runtime provider.
- [Runloop Runtime](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/runtimes/runloop.md): Runloop provides a fast, secure and scalable AI sandbox (Devbox). Check out the [runloop docs](https://docs.runloop.ai/overview/what-is-runloop) for more detail.
- [E2B Runtime](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/runtimes/e2b.md): E2B is an open-source secure cloud environment (sandbox) made for running AI-generated code and agents.
- [Configuration Options](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/advanced/configuration-options.md): This page outlines all available configuration options for OpenHands, allowing you to customize its behavior and integrate it with other services.
- [Custom Sandbox](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/advanced/custom-sandbox-guide.md): 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.
- [Search Engine Setup](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/advanced/search-engine-setup.md): Configure OpenHands to use Tavily as a search engine.
- [Secrets Management](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/settings/secrets-settings.md): How to manage secrets in OpenHands.
- [Model Context Protocol (MCP)](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/settings/mcp-settings.md): 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.
- [Repository Customization](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/customization/repository.md): You can customize how OpenHands interacts with your repository by creating a `.openhands` directory at the root level.
- [Microagents Overview](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/microagents/microagents-overview.md): Microagents are specialized prompts that enhance OpenHands with domain-specific knowledge. They provide expert guidance, automate common tasks, and ensure consistent practices across projects.
- [General Microagents](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/microagents/microagents-repo.md): General guidelines for OpenHands to work more effectively with the repository.
- [Keyword-Triggered Microagents](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/microagents/microagents-keyword.md): 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.
- [Organization and User Microagents](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/microagents/microagents-org.md): Organizations and users can define microagents that apply to all repositories belonging to the organization or user.
- [Global Microagents](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/microagents/microagents-public.md): Global microagents are [keyword-triggered microagents](/openhands/usage/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).
- [Prompting Best Practices](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/tips/prompting-best-practices.md): 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.
- [Troubleshooting](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/troubleshooting/troubleshooting.md)
- [Feedback](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/troubleshooting/feedback.md)
- [Development Overview](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/developers/development-overview.md): 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.
- [Backend Architecture](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/architecture/backend.md)
- [Runtime Architecture](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/architecture/runtime.md)
- [Debugging](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/developers/debugging.md)
- [Evaluation Harness](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/developers/evaluation-harness.md)
- [WebSocket Connection](https://allhandsai-sdk-docs.mintlify.site/openhands/usage/developers/websocket-connection.md)
- [Introduction](https://allhandsai-sdk-docs.mintlify.site/sdk/index.md): A clean, modular SDK for building AI agents. Core agent framework and production-ready tool implementations.
- [Success Stories](https://allhandsai-sdk-docs.mintlify.site/success-stories/index.md): Real-world examples of what you can achieve with OpenHands
- [List Supported Models](https://allhandsai-sdk-docs.mintlify.site/api-reference/list-supported-models.md): List model identifiers available on this server based on configured providers.
- [List Agents](https://allhandsai-sdk-docs.mintlify.site/api-reference/list-agents.md): List available agent types supported by this server.
- [List Security Analyzers](https://allhandsai-sdk-docs.mintlify.site/api-reference/list-security-analyzers.md): List supported security analyzers.
- [Get Config](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-config.md): Get current config.
- [List Workspace Files](https://allhandsai-sdk-docs.mintlify.site/api-reference/list-workspace-files.md): List workspace files visible to the conversation runtime. Applies .gitignore and internal ignore rules.
- [Get File Content](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-file-content.md): Return the content of the given file from the conversation workspace.
- [Download Workspace Archive](https://allhandsai-sdk-docs.mintlify.site/api-reference/download-workspace-archive.md): Return a ZIP archive of the current conversation workspace.
- [Git Changes](https://allhandsai-sdk-docs.mintlify.site/api-reference/git-changes.md)
- [Git Diff](https://allhandsai-sdk-docs.mintlify.site/api-reference/git-diff.md)
- [Upload Files](https://allhandsai-sdk-docs.mintlify.site/api-reference/upload-files.md)
- [Submit Feedback](https://allhandsai-sdk-docs.mintlify.site/api-reference/submit-feedback.md): Submit user feedback.
- [Get Remote Runtime Config](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-remote-runtime-config.md): Retrieve the runtime configuration.
- [Search Events](https://allhandsai-sdk-docs.mintlify.site/api-reference/search-events.md): Search through the event stream with filtering and pagination.
- [Add Event](https://allhandsai-sdk-docs.mintlify.site/api-reference/add-event.md)
- [Get Microagents](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-microagents.md): Get all microagents associated with the conversation.
- [Search Conversations](https://allhandsai-sdk-docs.mintlify.site/api-reference/search-conversations.md)
- [New Conversation](https://allhandsai-sdk-docs.mintlify.site/api-reference/new-conversation.md): Initialize a new session or join an existing one.
- [Get Conversation](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-conversation.md)
- [Delete Conversation](https://allhandsai-sdk-docs.mintlify.site/api-reference/delete-conversation.md)
- [Update Conversation](https://allhandsai-sdk-docs.mintlify.site/api-reference/update-conversation.md): Update conversation metadata.
- [Get Prompt](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-prompt.md)
- [Start Conversation](https://allhandsai-sdk-docs.mintlify.site/api-reference/start-conversation.md): Start an agent loop for a conversation.
- [Stop Conversation](https://allhandsai-sdk-docs.mintlify.site/api-reference/stop-conversation.md): Stop an agent loop for a conversation.
- [Load Settings](https://allhandsai-sdk-docs.mintlify.site/api-reference/load-settings.md)
- [Store Settings](https://allhandsai-sdk-docs.mintlify.site/api-reference/store-settings.md)
- [Reset Settings](https://allhandsai-sdk-docs.mintlify.site/api-reference/reset-settings.md): Resets user settings. (Deprecated)
- [Store Provider Tokens](https://allhandsai-sdk-docs.mintlify.site/api-reference/store-provider-tokens.md)
- [Unset Provider Tokens](https://allhandsai-sdk-docs.mintlify.site/api-reference/unset-provider-tokens.md)
- [Load Custom Secrets Names](https://allhandsai-sdk-docs.mintlify.site/api-reference/load-custom-secrets-names.md)
- [Create Custom Secret](https://allhandsai-sdk-docs.mintlify.site/api-reference/create-custom-secret.md)
- [Update Custom Secret](https://allhandsai-sdk-docs.mintlify.site/api-reference/update-custom-secret.md)
- [Delete Custom Secret](https://allhandsai-sdk-docs.mintlify.site/api-reference/delete-custom-secret.md)
- [Get User Installations](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-user-installations.md)
- [Get User Repositories](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-user-repositories.md)
- [Get User](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-user.md)
- [Search Repositories](https://allhandsai-sdk-docs.mintlify.site/api-reference/search-repositories.md)
- [Get Suggested Tasks](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-suggested-tasks.md): Get suggested tasks for the authenticated user across their most recently pushed repositories.
- [Get Repository Branches](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-repository-branches.md): Get branches for a repository.
- [Get Repository Microagents](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-repository-microagents.md): Scan the microagents directory of a repository and return the list of microagents.
- [Get Repository Microagent Content](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-repository-microagent-content.md): Fetch the content of a specific microagent file from a repository.
- [Get Trajectory](https://allhandsai-sdk-docs.mintlify.site/api-reference/get-trajectory.md): Get trajectory.
- [Alive](https://allhandsai-sdk-docs.mintlify.site/api-reference/alive.md)
- [Health](https://allhandsai-sdk-docs.mintlify.site/api-reference/health.md)

## OpenAPI Specs

- [openapi](https://allhandsai-sdk-docs.mintlify.site/openapi/openapi.json)

## Optional

- [Company](https://www.all-hands.dev/)
- [Blog](https://www.all-hands.dev/blog)
- [OpenHands Cloud](https://app.all-hands.dev)