# OpenHands Docs

## Docs

- [Introduction](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/introduction.md): Welcome to OpenHands, a community focused on AI-driven development
- [Quick Start](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/quickstart.md): Running OpenHands Cloud or running on your own.
- [First Projects](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/first-projects.md): So you've [run OpenHands](/overview/quickstart). Now what?
- [FAQs](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/faqs.md): Frequently asked questions about OpenHands.
- [Community](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/community.md): Learn about the OpenHands community, mission, and values
- [Model Context Protocol (MCP)](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/model-context-protocol.md): Model Context Protocol support across OpenHands platforms
- [Skills (formerly Microagents)](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/skills.md): Skills support across OpenHands platforms
- [Skills Overview (formerly Microagents)](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/skills/overview.md): Skills (formerly known as 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 Skills (formerly Microagents)](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/skills/repo.md): General guidelines for OpenHands to work more effectively with the repository.
- [Keyword-Triggered Skills (formerly Microagents)](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/skills/keyword.md): Keyword-triggered skills (formerly known as 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 Skills (formerly Microagents)](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/skills/org.md): Organizations and users can define skills (formerly known as microagents) that apply to all repositories belonging to the organization or user.
- [Global Skills (formerly Microagents)](https://allhandsai-fix-security-analyzer-examples.mintlify.site/overview/skills/public.md): Global skills (formerly known as microagents) are [keyword-triggered skills](/overview/skills/keyword) that apply to all OpenHands users. The official global skill registry is maintained at [github.com/OpenHands/skills](https://github.com/OpenHands/skills).
- [Prompting Best Practices](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.mintlify.site/openhands/usage/troubleshooting/troubleshooting.md)
- [Feedback](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/troubleshooting/feedback.md)
- [Key Features](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/key-features.md)
- [Getting Started](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/cloud/openhands-cloud.md): Getting started with OpenHands Cloud.
- [Bitbucket Integration](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/cloud/slack-installation.md): This guide walks you through installing the OpenHands Slack app.
- [Jira Cloud Integration](https://allhandsai-fix-security-analyzer-examples.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.
- [Cloud UI](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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.
- [Setup](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/run-openhands/local-setup.md): Getting started with running OpenHands on your own.
- [Configure](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/run-openhands/gui-mode.md): High level overview of configuring the OpenHands Web interface.
- [List Supported Models](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/list-supported-models.md): List model identifiers available on this server based on configured providers.
- [List Agents](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/list-agents.md): List available agent types supported by this server.
- [List Security Analyzers](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/list-security-analyzers.md): List supported security analyzers.
- [Get Config](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/get-config.md): Get current config.
- [List Workspace Files](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.mintlify.site/api-reference/get-file-content.md): Return the content of the given file from the conversation workspace.
- [Download Workspace Archive](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/download-workspace-archive.md): Return a ZIP archive of the current conversation workspace.
- [Git Changes](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/git-changes.md)
- [Git Diff](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/git-diff.md)
- [Upload Files](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/upload-files.md)
- [Submit Feedback](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/submit-feedback.md): Submit user feedback.
- [Get Remote Runtime Config](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/get-remote-runtime-config.md): Retrieve the runtime configuration.
- [Search Events](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/search-events.md): Search through the event stream with filtering and pagination.
- [Add Event](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/add-event.md)
- [Get Microagents](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/get-microagents.md): Get all microagents associated with the conversation.
- [Search Conversations](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/search-conversations.md)
- [New Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/new-conversation.md): Initialize a new session or join an existing one.
- [Get Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/get-conversation.md)
- [Delete Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/delete-conversation.md)
- [Update Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/update-conversation.md): Update conversation metadata.
- [Get Prompt](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/get-prompt.md)
- [Start Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/start-conversation.md): Start an agent loop for a conversation.
- [Stop Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/stop-conversation.md): Stop an agent loop for a conversation.
- [Load Settings](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/load-settings.md)
- [Store Settings](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/store-settings.md)
- [Reset Settings](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/reset-settings.md): Resets user settings. (Deprecated)
- [Store Provider Tokens](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/store-provider-tokens.md)
- [Unset Provider Tokens](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/unset-provider-tokens.md)
- [Load Custom Secrets Names](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/load-custom-secrets-names.md)
- [Create Custom Secret](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/create-custom-secret.md)
- [Update Custom Secret](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/update-custom-secret.md)
- [Delete Custom Secret](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/delete-custom-secret.md)
- [Get User Installations](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/get-user-installations.md)
- [Get User Repositories](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/get-user-repositories.md)
- [Get User](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/get-user.md)
- [Search Repositories](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/search-repositories.md)
- [Get Suggested Tasks](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.mintlify.site/api-reference/get-repository-branches.md): Get branches for a repository.
- [Get Repository Microagents](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.mintlify.site/api-reference/get-repository-microagent-content.md): Fetch the content of a specific microagent file from a repository.
- [Get Trajectory](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/get-trajectory.md): Get trajectory.
- [Alive](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/alive.md)
- [Health](https://allhandsai-fix-security-analyzer-examples.mintlify.site/api-reference/health.md)
- [Application Settings](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/settings/application-settings.md): Configure application-level settings for OpenHands.
- [Language Model (LLM) Settings](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/settings/llm-settings.md): This page goes over how to set the LLM to use in OpenHands. As well as some additional LLM settings.
- [Integrations Settings](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/settings/integrations-settings.md): How to setup and modify the various integrations in OpenHands.
- [Secrets Management](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/settings/secrets-settings.md): How to manage secrets in OpenHands.
- [API Keys Settings](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/settings/api-keys-settings.md): View your OpenHands LLM key and create API keys to work with OpenHands programmatically.
- [Model Context Protocol (MCP)](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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.
- [Overview](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.mintlify.site/openhands/usage/llms/moonshot.md): How to use Moonshot AI models with OpenHands
- [OpenAI](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.mintlify.site/openhands/usage/runtimes/docker.md): This is the default Runtime that's used when you start OpenHands.
- [Remote Runtime](https://allhandsai-fix-security-analyzer-examples.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/OpenHands/OpenHands/tree/main/evaluation). It should not be used to launch production OpenHands applications.
- [Local Runtime](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.mintlify.site/openhands/usage/runtimes/modal.md)
- [Daytona Runtime](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/runtimes/daytona.md): You can use [Daytona](https://www.daytona.io/) as a runtime provider.
- [Runloop Runtime](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.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-fix-security-analyzer-examples.mintlify.site/openhands/usage/advanced/search-engine-setup.md): Configure OpenHands to use Tavily as a search engine.
- [CLI](https://allhandsai-fix-security-analyzer-examples.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.
- [CLI Settings](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openhands/usage/run-openhands/cli-settings.md): Configuration and command reference for the OpenHands Command-Line Interface
- [Headless](https://allhandsai-fix-security-analyzer-examples.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-fix-security-analyzer-examples.mintlify.site/openhands/usage/run-openhands/github-action.md): This guide explains how to use the OpenHands GitHub Action in your own projects.
- [Software Agent SDK](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/index.md): Build AI agents that write software. A clean, modular SDK with production-ready tools.
- [Getting Started](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/getting-started.md): Install the OpenHands SDK and build AI agents that write software.
- [Hello World](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/hello-world.md): The simplest possible OpenHands agent - configure an LLM, create an agent, and complete a task.
- [Custom Tools](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/custom-tools.md): Tools define what agents can do. The SDK includes built-in tools for common operations and supports creating custom tools for specialized needs.
- [Model Context Protocol](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/mcp.md): Model Context Protocol (MCP) enables dynamic tool integration from external servers. Agents can discover and use MCP-provided tools automatically.
- [Agent Skills & Context](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/skill.md): Skills add specialized behaviors, domain knowledge, and context-aware triggers to your agent through structured prompts.
- [Persistence](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/convo-persistence.md): Save and restore conversation state for multi-session workflows.
- [Context Condenser](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/context-condenser.md): Manage agent memory by condensing conversation history to save tokens.
- [Sub-Agent Delegation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-delegation.md): Enable parallel task execution by delegating work to multiple sub-agents that run independently and return consolidated results.
- [Security & Action Confirmation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/security.md): Control agent action execution through confirmation policy and security analyzer.
- [Metrics Tracking](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/metrics.md): Track token usage, costs, and latency metrics for your agents.
- [Observability & Tracing](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/observability.md): Enable OpenTelemetry tracing to monitor and debug your agent's execution with tools like Laminar, Honeycomb, or any OTLP-compatible backend.
- [Secret Registry](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/secrets.md): Provide environment variables and secrets to agent workspace securely.
- [LLM Registry](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/llm-registry.md): Dynamically select and configure language models using the LLM registry.
- [Model Routing](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/llm-routing.md): Route agent's LLM requests to different models.
- [Reasoning](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/llm-reasoning.md): Access model reasoning traces from Anthropic extended thinking and OpenAI responses API.
- [Image Input](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/llm-image-input.md): Send images to multimodal agents for vision-based tasks and analysis.
- [Exception Handling](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/llm-error-handling.md): Provider‑agnostic exceptions raised by the SDK and recommended patterns for handling them.
- [Interactive Terminal](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-interactive-terminal.md): Enable agents to interact with terminal applications like ipython, python REPL, and other interactive CLI tools.
- [Browser Use](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-browser-use.md): Enable web browsing and interaction capabilities for your agent.
- [Creating Custom Agent](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-custom.md): Learn how to design specialized agents with custom tool sets
- [Custom Visualizer](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/convo-custom-visualizer.md): Customize conversation visualization by creating custom visualizers or configuring the default visualizer.
- [Stuck Detector](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-stuck-detector.md): Detect and handle stuck agents automatically with timeout mechanisms.
- [Pause and Resume](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/convo-pause-and-resume.md): Pause agent execution, perform operations, and resume without losing state.
- [Send Message While Running](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/convo-send-message-while-running.md): Interrupt running agents to provide additional context or corrections.
- [Conversation with Async](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/convo-async.md): Use async/await for concurrent agent operations and non-blocking execution.
- [Ask Agent Questions](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/convo-ask-agent.md): Get sidebar replies from the agent during conversation execution without interrupting the main flow.
- [Overview](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/overview.md): Run agents on remote servers with isolated workspaces for production deployments.
- [Local Agent Server](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/local-server.md): Run agents through a local HTTP server with RemoteConversation for client-server architecture.
- [Docker Sandbox](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/docker-sandbox.md): Run agent server in isolated Docker containers for security and reproducibility.
- [API-based Sandbox](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-sandbox.md): Connect to hosted API-based agent server for fully managed infrastructure.
- [Alive](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/server-details/alive.md)
- [Health](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/server-details/health.md)
- [Get Server Info](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/server-details/get-server-info.md)
- [Search Conversation Events](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/events/search-conversation-events.md): Search / List local events
- [Count Conversation Events](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/events/count-conversation-events.md): Count local events matching the given filters
- [Get Conversation Event](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/events/get-conversation-event.md): Get a local event given an id
- [Batch Get Conversation Events](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/events/batch-get-conversation-events.md): Get a batch of local events given their ids, returning null for any missing item.
- [Send Message](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/events/send-message.md): Send a message to a conversation
- [Respond To Confirmation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/events/respond-to-confirmation.md): Accept or reject a pending action in confirmation mode.
- [Search Conversations](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/search-conversations.md): Search / List conversations
- [Count Conversations](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/count-conversations.md): Count conversations matching the given filters
- [Get Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/get-conversation.md): Given an id, get a conversation
- [Delete Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/delete-conversation.md): Permanently delete a conversation.
- [Update Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/update-conversation.md): Update conversation metadata.
- [Batch Get Conversations](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/batch-get-conversations.md): Get a batch of conversations given their ids, returning null for any missing item
- [Start Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/start-conversation.md): Start a conversation in the local environment.
- [Pause Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/pause-conversation.md): Pause a conversation, allowing it to be resumed later.
- [Run Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/run-conversation.md): Start running the conversation in the background.
- [Update Conversation Secrets](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/update-conversation-secrets.md): Update secrets for a conversation.
- [Set Conversation Confirmation Policy](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/set-conversation-confirmation-policy.md): Set the confirmation policy for a conversation.
- [Set Conversation Security Analyzer](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/set-conversation-security-analyzer.md): Set the security analyzer for a conversation.
- [Generate Conversation Title](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/conversations/generate-conversation-title.md): Generate a title for the conversation using LLM.
- [List Available Tools](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/tools/list-available-tools.md): List all available tools.
- [Search Bash Events](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/bash/search-bash-events.md): Search / List bash event events
- [Get Bash Event](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/bash/get-bash-event.md): Get a bash event event given an id
- [Batch Get Bash Events](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/bash/batch-get-bash-events.md): Get a batch of bash event events given their ids, returning null for any missing item.
- [Start Bash Command](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/bash/start-bash-command.md): Execute a bash command in the background
- [Execute Bash Command](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/bash/execute-bash-command.md): Execute a bash command and wait for a result
- [Clear All Bash Events](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/bash/clear-all-bash-events.md): Clear all bash events from storage
- [Git Changes](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/git/git-changes.md)
- [Git Diff](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/git/git-diff.md)
- [Upload File](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/files/upload-file.md): Upload a file to the workspace.
- [Download File](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/files/download-file.md): Download a file from the workspace.
- [Download Trajectory](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/files/download-trajectory.md): Download a file from the workspace.
- [Get Vscode Url](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/vscode/get-vscode-url.md): Get the VSCode URL with authentication token.
- [Get Vscode Status](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/vscode/get-vscode-status.md): Get the VSCode server status.
- [Get Desktop Url](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/desktop/get-desktop-url.md): Get the noVNC URL for desktop access.
- [Get Server Info](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/agent-server/api-reference/get-server-info.md)
- [Assign Reviews](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/github-workflows/assign-reviews.md): Automate PR management with intelligent reviewer assignment and workflow notifications using OpenHands Agent
- [PR Review](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/github-workflows/pr-review.md): Use OpenHands Agent to generate meaningful pull request review
- [TODO Management](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/guides/github-workflows/todo-management.md): Implement TODOs using OpenHands Agent
- [Overview](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/overview.md): Understanding the OpenHands Software Agent SDK's package structure, component interactions, and execution models.
- [Design Principles](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/design.md): Core architectural principles guiding the OpenHands Software Agent SDK's development.
- [Agent](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/agent.md): High-level architecture of the reasoning-action loop
- [Conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/conversation.md): High-level architecture of the conversation orchestration system
- [Tool System & MCP](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/tool-system.md): High-level architecture of the action-observation tool framework
- [Events](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/events.md): High-level architecture of the typed event framework
- [Workspace](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/workspace.md): High-level architecture of the execution environment abstraction
- [LLM](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/llm.md): High-level architecture of the provider-agnostic language model interface
- [Skill](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/skill.md): High-level architecture of the reusable prompt system
- [Condenser](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/condenser.md): High-level architecture of the conversation history compression system
- [Security](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/arch/security.md): High-level architecture of action security analysis and validation
- [openhands.sdk.agent](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/api-reference/openhands.sdk.agent.md): API reference for openhands.sdk.agent module
- [openhands.sdk.conversation](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/api-reference/openhands.sdk.conversation.md): API reference for openhands.sdk.conversation module
- [openhands.sdk.event](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/api-reference/openhands.sdk.event.md): API reference for openhands.sdk.event module
- [openhands.sdk.llm](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/api-reference/openhands.sdk.llm.md): API reference for openhands.sdk.llm module
- [openhands.sdk.security](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/api-reference/openhands.sdk.security.md): API reference for openhands.sdk.security module
- [openhands.sdk.tool](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/api-reference/openhands.sdk.tool.md): API reference for openhands.sdk.tool module
- [openhands.sdk.utils](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/api-reference/openhands.sdk.utils.md): API reference for openhands.sdk.utils module
- [openhands.sdk.workspace](https://allhandsai-fix-security-analyzer-examples.mintlify.site/sdk/api-reference/openhands.sdk.workspace.md): API reference for openhands.sdk.workspace module

## OpenAPI Specs

- [openapi](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openapi/openapi.json)
- [agent-sdk](https://allhandsai-fix-security-analyzer-examples.mintlify.site/openapi/agent-sdk.json)

## Optional

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