# OpenHands Docs

- [Introduction](https://docs.openhands.dev/overview/introduction.md): Welcome to OpenHands, a community focused on AI-driven development
- [Quick Start](https://docs.openhands.dev/overview/quickstart.md): Choose how you want to run OpenHands
- [Tutorial Library](https://docs.openhands.dev/openhands/usage/get-started/tutorials.md): Centralized hub for OpenHands tutorials and examples
- [When to Use OpenHands](https://docs.openhands.dev/openhands/usage/essential-guidelines/when-to-use-openhands.md): Guidance on when OpenHands is the right tool for your task
- [Prompting Best Practices](https://docs.openhands.dev/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.
- [Good vs. Bad Instructions](https://docs.openhands.dev/openhands/usage/essential-guidelines/good-vs-bad-instructions.md): Learn how to write effective instructions for OpenHands
- [OpenHands in Your SDLC](https://docs.openhands.dev/openhands/usage/essential-guidelines/sdlc-integration.md): How OpenHands fits into your software development lifecycle
- [Use Cases Overview](https://docs.openhands.dev/openhands/usage/use-cases/overview.md): Explore how OpenHands can help with common software development challenges
- [Vulnerability Remediation](https://docs.openhands.dev/openhands/usage/use-cases/vulnerability-remediation.md): Using OpenHands to identify and fix security vulnerabilities in your codebase
- [Automated Code Review](https://docs.openhands.dev/openhands/usage/use-cases/code-review.md): Set up automated PR reviews using OpenHands and the Software Agent SDK
- [Automated QA Testing](https://docs.openhands.dev/openhands/usage/use-cases/qa-changes.md): Validate pull request changes by actually running the software — not just reading code or running tests
- [Incident Triage](https://docs.openhands.dev/openhands/usage/use-cases/incident-triage.md): Using OpenHands to investigate and resolve production incidents
- [COBOL Modernization](https://docs.openhands.dev/openhands/usage/use-cases/cobol-modernization.md): Modernizing legacy COBOL systems with OpenHands
- [Dependency Upgrades](https://docs.openhands.dev/openhands/usage/use-cases/dependency-upgrades.md): Automating dependency updates and upgrades with OpenHands
- [Agent-Driven Daily Workflow](https://docs.openhands.dev/openhands/usage/use-cases/daily-workflow.md): Use the OpenHands Agent Canvas to gather, prioritize, and work through your daily development tasks
- [Software Factory](https://docs.openhands.dev/openhands/usage/use-cases/software-factory.md): Configure four independent automations in Agent Canvas to take GitHub issues through development, review, testing, and merge.
- [Spark Migrations](https://docs.openhands.dev/openhands/usage/use-cases/spark-migrations.md): Migrating Apache Spark applications with OpenHands
- [Key Features](https://docs.openhands.dev/openhands/usage/key-features.md)
- [Hooks](https://docs.openhands.dev/openhands/usage/customization/hooks.md): Use lifecycle hooks to control agent behavior - block dangerous commands, enforce quality checks before stopping, inject context, and more.
- [Model Context Protocol (MCP)](https://docs.openhands.dev/overview/model-context-protocol.md): Model Context Protocol support across OpenHands platforms
- [Skills Overview](https://docs.openhands.dev/overview/skills.md): Give OpenHands reusable instructions, domain knowledge, workflows, and supporting resources.
- [General Skills](https://docs.openhands.dev/overview/skills/repo.md): General guidelines for OpenHands to work more effectively with the repository.
- [Keyword-Triggered Skills](https://docs.openhands.dev/overview/skills/keyword.md): Keyword-triggered skills 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.
- [Path-Triggered Rules](https://docs.openhands.dev/overview/skills/path.md): Path-triggered rules are skills that OpenHands injects deterministically whenever the agent reads, edits, or creates a file whose path matches a glob pattern. They behave like Claude Code "rules" — guaranteed to load for the files they scope, with no reliance on the model choosing them.
- [Organization and User Skills](https://docs.openhands.dev/overview/skills/org.md): Organizations and users can define skills that apply to all repositories belonging to the organization or user.
- [Global Skills](https://docs.openhands.dev/overview/skills/public.md): Global skills are [keyword-triggered skills](/overview/skills/keyword) that apply to all OpenHands users. The official global skill registry is maintained at [github.com/OpenHands/extensions](https://github.com/OpenHands/extensions).
- [Adding New Skills](https://docs.openhands.dev/overview/skills/adding.md): Learn how to add existing skills to your OpenHands workspace from the official registry or custom repositories.
- [Creating New Skills](https://docs.openhands.dev/overview/skills/creating.md): Learn how to create reusable skills instead of repeating prompts, with best practices for structure, triggers, and content organization.
- [Monitoring and Improving Skills](https://docs.openhands.dev/overview/skills/monitoring.md): Monitor skill performance in production using logging, evaluation metrics, dashboarding, and automated feedback aggregation.
- [Plugins](https://docs.openhands.dev/overview/plugins.md): Plugins bundle multiple agent components together—skills, hooks, MCP servers, agents, and commands—into reusable packages that extend OpenHands capabilities.
- [Agent Plugins Packages](https://docs.openhands.dev/overview/agent-plugins.md): OpenHands loads plugins published in the portable Agent Plugins format, so a single package works across every compatible client.
- [Automations Overview](https://docs.openhands.dev/openhands/usage/automations/overview.md): Create scheduled tasks that run automatically in OpenHands.
- [Creating Automations](https://docs.openhands.dev/openhands/usage/automations/creating-automations.md): Learn how to create scheduled automations using the Automation Skill.
- [Event-Based Automations](https://docs.openhands.dev/openhands/usage/automations/event-automations.md): Trigger automations from GitHub events or custom webhooks instead of cron schedules.
- [Managing Automations](https://docs.openhands.dev/openhands/usage/automations/managing-automations.md): List, update, enable, disable, and delete your automations.
- [Repository Customization](https://docs.openhands.dev/openhands/usage/customization/repository.md): You can customize how OpenHands interacts with your repository by creating a `.openhands` directory at the root level.
- [Application Settings](https://docs.openhands.dev/openhands/usage/settings/application-settings.md): Configure application-level settings for OpenHands.
- [Language Model (LLM) Settings](https://docs.openhands.dev/openhands/usage/settings/llm-settings.md): This page goes over how to set the LLM to use in OpenHands, including LLM profiles for switching models during conversations.
- [Secrets Management](https://docs.openhands.dev/openhands/usage/settings/secrets-settings.md): How to manage secrets in OpenHands.
- [Model Context Protocol (MCP)](https://docs.openhands.dev/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.
- [REST API (V1)](https://docs.openhands.dev/openhands/usage/api/v1.md): Overview of the Sandbox Server V1 REST endpoints for conversations and sandboxes.
- [Overview](https://docs.openhands.dev/openhands/usage/llms/llms.md): OpenHands can connect to any LLM supported by LiteLLM. However, it requires a powerful model to work.
- [OpenHands](https://docs.openhands.dev/openhands/usage/llms/openhands-llms.md): OpenHands LLM provider with access to state-of-the-art (SOTA) agentic coding models.
- [AWS Bedrock](https://docs.openhands.dev/openhands/usage/llms/aws-bedrock.md): OpenHands uses LiteLLM to make calls to AWS Bedrock models. You can find their documentation on using Bedrock as a provider [here](https://docs.litellm.ai/docs/providers/bedrock).
- [Azure](https://docs.openhands.dev/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://docs.openhands.dev/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://docs.openhands.dev/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).
- [Run Local LLMs with OpenHands](https://docs.openhands.dev/openhands/usage/llms/local-llms.md): Connect OpenHands to local LLM servers such as LM Studio, Ollama, vLLM, and SGLang.
- [LiteLLM Proxy](https://docs.openhands.dev/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://docs.openhands.dev/openhands/usage/llms/moonshot.md): How to use Moonshot AI models with OpenHands
- [OpenAI](https://docs.openhands.dev/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).
- [Use OpenRouter with OpenHands](https://docs.openhands.dev/openhands/usage/llms/openrouter.md): Configure an OpenRouter model and API key in Agent Canvas or OpenHands.
- [Setup](https://docs.openhands.dev/openhands/usage/run-openhands/local-setup.md): Getting started with running OpenHands on your own.
- [Configure](https://docs.openhands.dev/openhands/usage/run-openhands/gui-mode.md): High level overview of configuring the OpenHands Web interface.
- [Troubleshooting](https://docs.openhands.dev/openhands/usage/troubleshooting/troubleshooting.md)
- [Overview](https://docs.openhands.dev/openhands/usage/sandboxes/overview.md): Where OpenHands runs code in V1: Docker sandbox, Process, or Remote.
- [Docker Sandbox](https://docs.openhands.dev/openhands/usage/sandboxes/docker.md): The recommended sandbox provider for running OpenHands locally.
- [Remote Sandbox](https://docs.openhands.dev/openhands/usage/sandboxes/remote.md): Run conversations in a remote sandbox environment.
- [Process Sandbox](https://docs.openhands.dev/openhands/usage/sandboxes/process.md): Run the agent server as a local process without container isolation.
- [Configuration Options](https://docs.openhands.dev/openhands/usage/advanced/configuration-options.md): How to configure OpenHands V1 (Web UI, env vars, and sandbox settings).
- [Custom Sandbox](https://docs.openhands.dev/openhands/usage/advanced/custom-sandbox-guide.md): Build and use your own agent-server image when you need extra tools, system packages, or language runtimes pre-installed in the sandbox.
- [Search Engine Setup](https://docs.openhands.dev/openhands/usage/advanced/search-engine-setup.md): Configure OpenHands to use Tavily as a search engine.
- [Installation](https://docs.openhands.dev/openhands/usage/cli/installation.md): Install the OpenHands CLI on your system
- [Quick Start](https://docs.openhands.dev/openhands/usage/cli/quick-start.md): Get started with OpenHands CLI in minutes
- [Terminal (CLI)](https://docs.openhands.dev/openhands/usage/cli/terminal.md): Use OpenHands interactively in your terminal with the command-line interface
- [Headless Mode](https://docs.openhands.dev/openhands/usage/cli/headless.md): Run OpenHands without UI for scripting, automation, and CI/CD pipelines
- [Web Interface](https://docs.openhands.dev/openhands/usage/cli/web-interface.md): Access the OpenHands CLI through your web browser
- [GUI Server](https://docs.openhands.dev/openhands/usage/cli/gui-server.md): Launch the full OpenHands web GUI using Docker
- [IDE Integration Overview](https://docs.openhands.dev/openhands/usage/cli/ide/overview.md): Use OpenHands directly in your favorite code editor through the Agent Client Protocol
- [Zed IDE](https://docs.openhands.dev/openhands/usage/cli/ide/zed.md): Configure OpenHands with the Zed code editor through the Agent Client Protocol
- [Toad Terminal](https://docs.openhands.dev/openhands/usage/cli/ide/toad.md): Use OpenHands with the Toad universal terminal interface for AI agents
- [VS Code](https://docs.openhands.dev/openhands/usage/cli/ide/vscode.md): Use OpenHands in Visual Studio Code with the VSCode ACP community extension
- [JetBrains IDEs](https://docs.openhands.dev/openhands/usage/cli/ide/jetbrains.md): Configure OpenHands with IntelliJ IDEA, PyCharm, WebStorm, and other JetBrains IDEs
- [OpenHands Cloud](https://docs.openhands.dev/openhands/usage/cli/cloud.md): Create and manage OpenHands Cloud conversations from the CLI
- [MCP Servers](https://docs.openhands.dev/openhands/usage/cli/mcp-servers.md): Manage Model Context Protocol servers to extend OpenHands capabilities
- [Critic (Experimental)](https://docs.openhands.dev/openhands/usage/cli/critic.md): Automatic task success prediction and iterative refinement for OpenHands LLM Provider users
- [Command Reference](https://docs.openhands.dev/openhands/usage/cli/command-reference.md): Complete reference for all OpenHands CLI commands and options
- [Resume Conversations](https://docs.openhands.dev/openhands/usage/cli/resume.md): How to resume previous conversations in the OpenHands CLI
- [Community](https://docs.openhands.dev/overview/community.md): Learn about the OpenHands community, mission, and values
- [Contributing](https://docs.openhands.dev/overview/contributing.md): Join us in building OpenHands and the future of AI. Learn how to contribute to make a meaningful impact.
- [Issue Triage and the ready-for-dev Gate](https://docs.openhands.dev/overview/issue-lifecycle.md): How issues are labeled and marked ready-for-dev, and what the pull request description check enforces.
- [FAQs](https://docs.openhands.dev/overview/faqs.md): Frequently asked questions about OpenHands.
- [Feedback](https://docs.openhands.dev/openhands/usage/troubleshooting/feedback.md)
- [Agent Canvas Overview](https://docs.openhands.dev/openhands/usage/agent-canvas/overview.md): Understand Agent Canvas, how it runs agents, and which setup path to choose.
- [Agent Canvas Architecture](https://docs.openhands.dev/openhands/usage/agent-canvas/architecture.md): Understand how Agent Canvas connects to execution, automation, and sandbox services.
- [Install Agent Canvas](https://docs.openhands.dev/openhands/usage/agent-canvas/setup.md): Install, run, update, or uninstall Agent Canvas.
- [First Time Setup](https://docs.openhands.dev/openhands/usage/agent-canvas/first-time-setup.md): Configure Agent Canvas after installation — choose your agent, connect a backend, add an LLM, and launch your first automation.
- [Managing automations](https://docs.openhands.dev/openhands/usage/agent-canvas/managing-automations.md): Browse, export, import, enable, disable, and run automations from the Agent Canvas Automate view.
- [Sync Automations with Git](https://docs.openhands.dev/openhands/usage/agent-canvas/git-sync.md): Back up, share, and edit Agent Canvas automations through a Git repository.
- [Setup a Pre-built Automation](https://docs.openhands.dev/openhands/usage/agent-canvas/prebuilt-automations.md): Get started quickly with a pre-built automation for common workflows.
- [Issue to Pull Request Automation](https://docs.openhands.dev/openhands/usage/agent-canvas/prebuilt/issue-to-pr.md): Automatically implement issues from your issue tracker and create pull requests.
- [GitHub PR Review Assistant](https://docs.openhands.dev/openhands/usage/agent-canvas/prebuilt/github-pr-review.md): Automatically review pull requests using an OpenHands agent.
- [GitHub Repository Monitor](https://docs.openhands.dev/openhands/usage/agent-canvas/prebuilt/github-repo-monitor.md): Monitor a GitHub repository and trigger agent actions on events.
- [Slack Channel Monitor](https://docs.openhands.dev/openhands/usage/agent-canvas/prebuilt/slack-channel-monitor.md): Watch a Slack channel and trigger agent actions on messages.
- [Conversations](https://docs.openhands.dev/openhands/usage/agent-canvas/conversations.md): Work with Agent Canvas conversations, including branching from previous messages.
- [Agent Profiles](https://docs.openhands.dev/openhands/usage/agent-canvas/agent-profiles.md): Manage reusable agent configurations for Agent Canvas conversations.
- [Manage LLM Profiles](https://docs.openhands.dev/openhands/usage/agent-canvas/llm-profiles.md): Configure models in Agent Canvas and use saved LLM profiles during conversations.
- [Configure a Model](https://docs.openhands.dev/openhands/usage/agent-canvas/model-configuration.md): Choose and verify an LLM configuration path in Agent Canvas.
- [ACP Agents](https://docs.openhands.dev/openhands/usage/agent-canvas/acp-agents.md): Run Claude Code, Codex, or Gemini CLI in Agent Canvas through the Agent Client Protocol.
- [Plugins in Agent Canvas](https://docs.openhands.dev/openhands/usage/agent-canvas/plugins.md): Browse, install, attach, and inspect plugins in Agent Canvas.
- [Apps (Beta)](https://docs.openhands.dev/openhands/usage/agent-canvas/canvas-extensions.md): Add trusted custom pages and integrated tools to Agent Canvas without forking the application.
- [Critic](https://docs.openhands.dev/openhands/usage/agent-canvas/critic.md): Configure critic evaluation and iterative refinement in Agent Canvas.
- [Customize and Settings](https://docs.openhands.dev/openhands/usage/agent-canvas/customize-and-settings.md): Teach your agent with skills and MCP servers, and configure how it runs with settings.
- [Phone & Tablet Access](https://docs.openhands.dev/openhands/usage/agent-canvas/mobile-access.md): Access Agent Canvas from a phone or tablet using Tailscale or ngrok.
- [Backends](https://docs.openhands.dev/openhands/usage/agent-canvas/backends.md): Understand and manage Agent Canvas backends.
- [Local Backend](https://docs.openhands.dev/openhands/usage/agent-canvas/backend-setup/local.md): Run one or more local backends and connect to them from the Agent Canvas UI.
- [Remote Backend](https://docs.openhands.dev/openhands/usage/agent-canvas/backend-setup/remote.md): Connect Agent Canvas to an Agent Server backend running on another machine or container.
- [Cloud Backend](https://docs.openhands.dev/openhands/usage/agent-canvas/backend-setup/cloud.md): Connect Agent Canvas to OpenHands Cloud for on-demand sandboxed execution.
- [VM / Self-Hosted Installation](https://docs.openhands.dev/openhands/usage/agent-canvas/backend-setup/vm.md): Install Agent Canvas on a VM as a backend-only service or full self-hosted Canvas.
- [Use Docker with Agent Canvas](https://docs.openhands.dev/openhands/usage/agent-canvas/backend-setup/docker.md): Run Agent Canvas with Docker for a sandboxed backend and mounted project workspace.
- [Run Each Conversation in Its Own Docker Container](https://docs.openhands.dev/openhands/usage/agent-canvas/backend-setup/docker-execution.md): Keep Agent Canvas on the host while each conversation runs in its own hardened Agent Server container with bind-mounted workspace and persistence directories.
- [Kubernetes (Helm)](https://docs.openhands.dev/openhands/usage/agent-canvas/backend-setup/kubernetes.md): Install Agent Canvas into a Kubernetes cluster with the official Helm chart.
- [Modal Backend](https://docs.openhands.dev/openhands/usage/agent-canvas/backend-setup/modal.md): Deploy the agent server on Modal as a remote backend for Agent Canvas.
- [Contributing](https://docs.openhands.dev/openhands/usage/agent-canvas/development.md): Contribute to Agent Canvas development.
- [Troubleshooting](https://docs.openhands.dev/openhands/usage/agent-canvas/troubleshooting.md): Fix common Agent Canvas install, startup, backend, model, workspace, and uninstall issues.
- [Agent Canvas 1.25.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.25.0.md): Release notes for Agent Canvas version 1.25.0
- [Agent Canvas 1.24.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.24.0.md): Release notes for Agent Canvas version 1.24.0
- [Agent Canvas 1.23.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.23.0.md): Release notes for Agent Canvas version 1.23.0
- [Agent Canvas 1.22.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.22.0.md): Release notes for Agent Canvas version 1.22.0
- [Agent Canvas 1.21.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.21.0.md): Release notes for Agent Canvas version 1.21.0
- [Agent Canvas 1.20.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.20.0.md): Release notes for Agent Canvas version 1.20.0
- [Agent Canvas 1.19.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.19.0.md): Release notes for Agent Canvas version 1.19.0
- [Agent Canvas 1.18.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.18.0.md): Release notes for Agent Canvas version 1.18.0
- [Agent Canvas 1.17.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.17.0.md): Release notes for Agent Canvas version 1.17.0
- [Agent Canvas 1.16.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.16.0.md): Release notes for Agent Canvas version 1.16.0
- [Agent Canvas 1.15.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.15.0.md): Release notes for Agent Canvas version 1.15.0
- [Agent Canvas 1.14.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.14.0.md): Release notes for Agent Canvas version 1.14.0
- [Agent Canvas 1.13.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.13.0.md): Release notes for Agent Canvas version 1.13.0
- [Agent Canvas 1.12.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.12.0.md): Release notes for Agent Canvas version 1.12.0
- [Agent Canvas 1.11.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.11.0.md): Release notes for Agent Canvas version 1.11.0
- [Agent Canvas 1.10.0](https://docs.openhands.dev/openhands/usage/agent-canvas/release-notes/v1.10.0.md): Release notes for Agent Canvas version 1.10.0
- [Software Agent SDK](https://docs.openhands.dev/sdk/index.md): Build AI agents that write software. A clean, modular SDK with production-ready tools.
- [Getting Started](https://docs.openhands.dev/sdk/getting-started.md): Install the OpenHands SDK and build AI agents that write software.
- [FAQ](https://docs.openhands.dev/sdk/faq.md): Frequently asked questions about the OpenHands SDK
- [Hello World](https://docs.openhands.dev/sdk/guides/hello-world.md): The simplest possible OpenHands agent - configure an LLM, create an agent, and complete a task.
- [Custom Tools](https://docs.openhands.dev/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.
- [Structured Output](https://docs.openhands.dev/sdk/guides/structured-output.md): Attach a schema to any tool so the LLM returns typed, validated fields alongside the tool's own arguments.
- [Model Context Protocol](https://docs.openhands.dev/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://docs.openhands.dev/sdk/guides/skill.md): Skills add specialized behaviors, domain knowledge, and context-aware triggers to your agent through structured prompts.
- [Plugins](https://docs.openhands.dev/sdk/guides/plugins.md): Plugins bundle skills, hooks, MCP servers, agents, and commands into reusable packages that extend agent capabilities.
- [Persistence](https://docs.openhands.dev/sdk/guides/convo-persistence.md): Save and restore conversation state for multi-session workflows.
- [Context Condenser](https://docs.openhands.dev/sdk/guides/context-condenser.md): Manage agent memory by condensing conversation history to save tokens.
- [Persistent Memory](https://docs.openhands.dev/sdk/guides/persistent-memory.md): Give agents opt-in, two-tier memory that survives across conversations.
- [Agent Settings](https://docs.openhands.dev/sdk/guides/agent-settings.md): Configure, serialize, and recreate agents from structured settings.
- [Parallel Tool Execution](https://docs.openhands.dev/sdk/guides/parallel-tool-execution.md): Execute multiple tools concurrently within a single LLM response to improve throughput for independent operations.
- [Task Tool Set](https://docs.openhands.dev/sdk/guides/task-tool-set.md): Delegate complex work to specialized sub-agents that run synchronously and return results to the parent agent.
- [Iterative Refinement](https://docs.openhands.dev/sdk/guides/iterative-refinement.md): Implement iterative refinement workflows where agents refine their work based on critique feedback until quality thresholds are met.
- [Security & Action Confirmation](https://docs.openhands.dev/sdk/guides/security.md): Control agent action execution through confirmation policy and security analyzer.
- [Metrics Tracking](https://docs.openhands.dev/sdk/guides/metrics.md): Track token usage, costs, and latency metrics for your agents.
- [Observability & Tracing](https://docs.openhands.dev/sdk/guides/observability.md): Enable OpenTelemetry tracing to monitor and debug your agent's execution with tools like Laminar, MLflow, Honeycomb, or any OTLP-compatible backend.
- [Secret Registry](https://docs.openhands.dev/sdk/guides/secrets.md): Provide environment variables and secrets to agent workspace securely.
- [LLM Subscriptions](https://docs.openhands.dev/sdk/guides/llm-subscriptions.md): Use your ChatGPT Plus/Pro subscription to access Codex models without consuming API credits.
- [LLM Registry](https://docs.openhands.dev/sdk/guides/llm-registry.md): Dynamically select and configure language models using the LLM registry.
- [Model Routing](https://docs.openhands.dev/sdk/guides/llm-routing.md): Route agent's LLM requests to different models.
- [Reasoning](https://docs.openhands.dev/sdk/guides/llm-reasoning.md): Access model reasoning traces from Anthropic extended thinking and OpenAI responses API.
- [GPT-5 Preset (ApplyPatchTool)](https://docs.openhands.dev/sdk/guides/llm-gpt5-preset.md): Use the GPT-5 preset to build an agent that swaps the standard FileEditorTool for ApplyPatchTool.
- [LLM Streaming](https://docs.openhands.dev/sdk/guides/llm-streaming.md): Stream LLM responses token-by-token for real-time display and interactive user experiences.
- [Image Input](https://docs.openhands.dev/sdk/guides/llm-image-input.md): Send images to multimodal agents for vision-based tasks and analysis.
- [Exception Handling](https://docs.openhands.dev/sdk/guides/llm-error-handling.md): Provider‑agnostic exceptions raised by the SDK and recommended patterns for handling them.
- [LLM Fallback Strategy](https://docs.openhands.dev/sdk/guides/llm-fallback.md): Automatically try alternate LLMs when the primary model fails with a transient error.
- [LLM Profile Store](https://docs.openhands.dev/sdk/guides/llm-profile-store.md): Save, load, and manage reusable LLM configurations so you never repeat setup code again.
- [Task-Based Model Routing](https://docs.openhands.dev/sdk/guides/llm-task-routing.md): Let the agent pick the best saved LLM profile for the task at hand with the built-in route_task_to_model tool.
- [ACP Agent](https://docs.openhands.dev/sdk/guides/agent-acp.md): Delegate to an ACP-compatible server (Claude Code, Gemini CLI, etc.) instead of calling an LLM directly.
- [Interactive Terminal](https://docs.openhands.dev/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://docs.openhands.dev/sdk/guides/agent-browser-use.md): Enable web browsing and interaction capabilities for your agent.
- [Browser Session Recording](https://docs.openhands.dev/sdk/guides/browser-session-recording.md): Record and replay your agent's browser sessions using rrweb.
- [Creating Custom Agent](https://docs.openhands.dev/sdk/guides/agent-custom.md): Learn how to design specialized agents with custom tool sets
- [File-Based Agents](https://docs.openhands.dev/sdk/guides/agent-file-based.md): Define specialized sub-agents as simple Markdown files with YAML frontmatter — no Python code required.
- [Stuck Detector](https://docs.openhands.dev/sdk/guides/agent-stuck-detector.md): Detect and handle stuck agents automatically with timeout mechanisms.
- [Ask Oracle](https://docs.openhands.dev/sdk/guides/agent-ask-oracle.md): Let an agent consult a saved Oracle LLM profile for stateless second-opinion advice.
- [Theory of Mind (TOM) Agent](https://docs.openhands.dev/sdk/guides/agent-tom-agent.md): Enable your agent to understand user intent and preferences through Theory of Mind capabilities, providing personalized guidance based on user modeling.
- [Critic (Experimental)](https://docs.openhands.dev/sdk/guides/critic.md): Real-time evaluation of agent actions using an LLM-based critic model, with built-in iterative refinement.
- [Fork a Conversation](https://docs.openhands.dev/sdk/guides/convo-fork.md): Branch off an existing conversation for follow-up exploration without contaminating the original.
- [Pause and Resume](https://docs.openhands.dev/sdk/guides/convo-pause-and-resume.md): Pause agent execution, perform operations, and resume without losing state.
- [Custom Visualizer](https://docs.openhands.dev/sdk/guides/convo-custom-visualizer.md): Customize conversation visualization by creating custom visualizers or configuring the default visualizer.
- [Send Message While Running](https://docs.openhands.dev/sdk/guides/convo-send-message-while-running.md): Interrupt running agents to provide additional context or corrections.
- [Conversation with Async](https://docs.openhands.dev/sdk/guides/convo-async.md): Use async/await for concurrent agent operations and non-blocking execution.
- [Ask Agent Questions](https://docs.openhands.dev/sdk/guides/convo-ask-agent.md): Get sidebar replies from the agent during conversation execution without interrupting the main flow.
- [Goal Completion Loop](https://docs.openhands.dev/sdk/guides/convo-goal.md): Drive a conversation toward a verifiable objective with a judge-driven, self-continuing completion loop.
- [Hooks](https://docs.openhands.dev/sdk/guides/hooks.md): Use lifecycle hooks to observe, log, and customize agent execution.
- [Overview](https://docs.openhands.dev/sdk/guides/agent-server/overview.md): Run agents on remote servers with isolated workspaces for production deployments.
- [Local Agent Server](https://docs.openhands.dev/sdk/guides/agent-server/local-server.md): Install and run an OpenHands Agent Server on your machine, then connect to it from the SDK.
- [Agent Server Package](https://docs.openhands.dev/sdk/arch/agent-server.md): Install, run, and secure the OpenHands Agent Server for remote agent execution.
- [Conversation Goals](https://docs.openhands.dev/sdk/guides/agent-server/conversation-goals.md): Add a resumable goal strategy to a normal agent-server conversation.
- [Docker Sandbox](https://docs.openhands.dev/sdk/guides/agent-server/docker-sandbox.md): Run agent server in isolated Docker containers for security and reproducibility.
- [Apptainer Sandbox](https://docs.openhands.dev/sdk/guides/agent-server/apptainer-sandbox.md): Run agent server in rootless Apptainer containers for HPC and shared computing environments.
- [API-based Sandbox](https://docs.openhands.dev/sdk/guides/agent-server/api-sandbox.md): Connect to hosted API-based agent server for fully managed infrastructure.
- [OpenHands Cloud Workspace](https://docs.openhands.dev/sdk/guides/agent-server/cloud-workspace.md): Connect to OpenHands Cloud for fully managed sandbox environments with optional SaaS credential inheritance.
- [Custom Tools with Remote Agent Server](https://docs.openhands.dev/sdk/guides/agent-server/custom-tools.md): Learn how to use custom tools with a remote agent server by building a custom base image that includes your tool implementations.
- [OpenAI-Compatible Endpoint](https://docs.openhands.dev/sdk/guides/agent-server/openai-gateway.md): Call an OpenHands agent-server through the OpenAI Chat Completions or Responses protocol.
- [Deferred Init (Warm-Pool)](https://docs.openhands.dev/sdk/guides/agent-server/deferred-init.md): Pre-warm agent-server pods before a user is matched, then activate them at runtime with POST /api/init.
- [Alive](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/server-details/alive.md): Basic liveness check - returns OK if the server process is running.
- [Health](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/server-details/health.md): Basic health check - returns OK if the server process is running.
- [Ready](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/server-details/ready.md): Readiness check - returns OK only if the server has completed initialization.
- [Get Server Info](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/server-details/get-server-info.md)
- [Search Conversation Events](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/events/search-conversation-events.md): Search / List local events
- [Count Conversation Events](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/events/count-conversation-events.md): Count local events matching the given filters
- [Get Conversation Event](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/events/get-conversation-event.md): Get a local event given an id
- [Batch Get Conversation Events](https://docs.openhands.dev/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://docs.openhands.dev/sdk/guides/agent-server/api-reference/events/send-message.md): Send a message to a conversation
- [Respond To Confirmation](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/events/respond-to-confirmation.md): Accept or reject a pending action in confirmation mode.
- [Search Conversations](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/search-conversations.md): Search / List conversations
- [Count Conversations](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/count-conversations.md): Count conversations matching the given filters
- [Get Conversation](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/get-conversation.md): Given an id, get a conversation
- [Delete Conversation](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/delete-conversation.md): Permanently delete a conversation.
- [Update Conversation](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/update-conversation.md): Update conversation metadata.
- [Batch Get Conversations](https://docs.openhands.dev/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://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/start-conversation.md): Start a conversation in the local environment.
- [Pause Conversation](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/pause-conversation.md): Pause a conversation, allowing it to be resumed later.
- [Run Conversation](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/run-conversation.md): Start running the conversation in the background.
- [Update Conversation Secrets](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/update-conversation-secrets.md): Update secrets for a conversation.
- [Set Conversation Confirmation Policy](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/set-conversation-confirmation-policy.md): Set the confirmation policy for a conversation.
- [Set Conversation Security Analyzer](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/set-conversation-security-analyzer.md): Set the security analyzer for a conversation.
- [Generate Conversation Title](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/generate-conversation-title.md): Generate a title for the conversation using LLM.
- [Ask Agent](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/ask-agent.md): Ask the agent a simple question without affecting conversation state.
- [Condense Conversation](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/conversations/condense-conversation.md): Force condensation of the conversation history.
- [List Available Tools](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/tools/list-available-tools.md): List all available tools.
- [Search Bash Events](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/bash/search-bash-events.md): Search / List bash event events
- [Get Bash Event](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/bash/get-bash-event.md): Get a bash event event given an id
- [Batch Get Bash Events](https://docs.openhands.dev/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://docs.openhands.dev/sdk/guides/agent-server/api-reference/bash/start-bash-command.md): Execute a bash command in the background
- [Execute Bash Command](https://docs.openhands.dev/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://docs.openhands.dev/sdk/guides/agent-server/api-reference/bash/clear-all-bash-events.md): Clear all bash events from storage
- [Git Changes](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/git/git-changes.md)
- [Git Diff](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/git/git-diff.md)
- [Upload File](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/files/upload-file.md): Upload a file to the workspace.
- [Download File](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/files/download-file.md): Download a file from the workspace.
- [Download Trajectory](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/files/download-trajectory.md): Download a file from the workspace.
- [Get Vscode Url](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/vscode/get-vscode-url.md): Get the VSCode URL with authentication token.
- [Get Vscode Status](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/vscode/get-vscode-status.md): Get the VSCode server status.
- [Get Desktop Url](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/desktop/get-desktop-url.md): Get the noVNC URL for desktop access.
- [Get Skills](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/skills/get-skills.md): Load and merge skills from all configured sources.
- [Sync Skills](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/skills/sync-skills.md): Force refresh of public skills from GitHub repository.
- [Get Hooks](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/hooks/get-hooks.md): Load hooks from the workspace .openhands/hooks.json file.
- [Get Server Info](https://docs.openhands.dev/sdk/guides/agent-server/api-reference/get-server-info.md)
- [Assign Reviews](https://docs.openhands.dev/sdk/guides/github-workflows/assign-reviews.md): Automate PR management with intelligent reviewer assignment and workflow notifications using OpenHands Agent
- [PR Review](https://docs.openhands.dev/sdk/guides/github-workflows/pr-review.md): Use OpenHands Agent to generate meaningful pull request review
- [TODO Management](https://docs.openhands.dev/sdk/guides/github-workflows/todo-management.md): Implement TODOs using OpenHands Agent
- [Overview](https://docs.openhands.dev/sdk/arch/overview.md): Understanding the OpenHands Software Agent SDK's package structure, component interactions, and execution models.
- [Design Principles](https://docs.openhands.dev/sdk/arch/design.md): Core architectural principles guiding the OpenHands Software Agent SDK's development.
- [Agent](https://docs.openhands.dev/sdk/arch/agent.md): High-level architecture of the reasoning-action loop
- [Conversation](https://docs.openhands.dev/sdk/arch/conversation.md): High-level architecture of the conversation orchestration system
- [Tool System & MCP](https://docs.openhands.dev/sdk/arch/tool-system.md): High-level architecture of the action-observation tool framework
- [MCP Integration](https://docs.openhands.dev/sdk/arch/mcp.md): High-level architecture of Model Context Protocol support
- [Events](https://docs.openhands.dev/sdk/arch/events.md): High-level architecture of the typed event framework
- [Workspace](https://docs.openhands.dev/sdk/arch/workspace.md): High-level architecture of the execution environment abstraction
- [LLM](https://docs.openhands.dev/sdk/arch/llm.md): High-level architecture of the provider-agnostic language model interface
- [Skill](https://docs.openhands.dev/sdk/arch/skill.md): High-level architecture of the reusable prompt system
- [Condenser](https://docs.openhands.dev/sdk/arch/condenser.md): High-level architecture of the conversation history compression system
- [Security](https://docs.openhands.dev/sdk/arch/security.md): High-level architecture of action security analysis and validation
- [openhands.sdk.agent](https://docs.openhands.dev/sdk/api-reference/openhands.sdk.agent.md): API reference for openhands.sdk.agent module
- [openhands.sdk.conversation](https://docs.openhands.dev/sdk/api-reference/openhands.sdk.conversation.md): API reference for openhands.sdk.conversation module
- [openhands.sdk.event](https://docs.openhands.dev/sdk/api-reference/openhands.sdk.event.md): API reference for openhands.sdk.event module
- [openhands.sdk.llm](https://docs.openhands.dev/sdk/api-reference/openhands.sdk.llm.md): API reference for openhands.sdk.llm module
- [openhands.sdk.security](https://docs.openhands.dev/sdk/api-reference/openhands.sdk.security.md): API reference for openhands.sdk.security module
- [openhands.sdk.tool](https://docs.openhands.dev/sdk/api-reference/openhands.sdk.tool.md): API reference for openhands.sdk.tool module
- [openhands.sdk.utils](https://docs.openhands.dev/sdk/api-reference/openhands.sdk.utils.md): API reference for openhands.sdk.utils module
- [openhands.sdk.workspace](https://docs.openhands.dev/sdk/api-reference/openhands.sdk.workspace.md): API reference for openhands.sdk.workspace module
- [Getting Started](https://docs.openhands.dev/openhands/usage/cloud/openhands-cloud.md): Getting started with OpenHands Cloud.
- [Cloud UI](https://docs.openhands.dev/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.
- [API Keys Settings](https://docs.openhands.dev/openhands/usage/settings/api-keys-settings.md): View your OpenHands LLM key and create API keys to work with OpenHands programmatically.
- [Integrations Settings](https://docs.openhands.dev/openhands/usage/settings/integrations-settings.md): How to setup and modify the various integrations in OpenHands.
- [GitHub Integration](https://docs.openhands.dev/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://docs.openhands.dev/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!.
- [Bitbucket Integration](https://docs.openhands.dev/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.
- [Slack Integration](https://docs.openhands.dev/openhands/usage/cloud/slack-installation.md): This guide walks you through installing the OpenHands Slack app.
- [Jira Cloud Integration](https://docs.openhands.dev/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 API Overview](https://docs.openhands.dev/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.
- [Plugin Launcher](https://docs.openhands.dev/openhands/usage/cloud/plugin-launcher.md): Use the OpenHands Cloud `/launch` route to open a conversation with plugins or skills pre-configured from a Git repository.
- [Search Events](https://docs.openhands.dev/openhands/usage/cloud/api-reference/events/search-events.md): Search / List events.
- [Count Events](https://docs.openhands.dev/openhands/usage/cloud/api-reference/events/count-events.md): Count events matching the given filters.
- [Batch Get Events](https://docs.openhands.dev/openhands/usage/cloud/api-reference/events/batch-get-events.md): Get a batch of events given their ids, returning null for any missing event.
- [Search App Conversations](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/search-app-conversations.md): Search / List sandboxed conversations.
- [Count App Conversations](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/count-app-conversations.md): Count sandboxed conversations matching the given filters.
- [Batch Get App Conversations](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/batch-get-app-conversations.md): Get a batch of sandboxed conversations given their ids. Return None for any missing.
- [Start App Conversation](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/start-app-conversation.md)
- [Delete App Conversation](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/delete-app-conversation.md): Delete an app conversation and its associated data.
- [Update App Conversation](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/update-app-conversation.md)
- [Send Message To Conversation](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/send-message-to-conversation.md): Send a follow-up message to an existing conversation.
- [Switch Conversation Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/switch-conversation-profile.md): Switch the running conversation's LLM to a saved profile.
- [Switch Conversation Acp Model](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/switch-conversation-acp-model.md): Switch the model of a running ACP conversation in place.
- [Stream App Conversation Start](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/stream-app-conversation-start.md): Start an app conversation start task and stream updates from it. Leaves the connection open until either the conversation starts or there was an error
- [Search App Conversation Start Tasks](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/search-app-conversation-start-tasks.md): Search / List conversation start tasks.
- [Count App Conversation Start Tasks](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/count-app-conversation-start-tasks.md): Count conversation start tasks matching the given filters.
- [Batch Get App Conversation Start Tasks](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/batch-get-app-conversation-start-tasks.md): Get a batch of start app conversation tasks given their ids. Return None for any missing.
- [Read Conversation File](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/read-conversation-file.md): Read a file from a specific conversation's sandbox workspace.
- [Get Conversation Git Changes](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/get-conversation-git-changes.md): Proxy ``GET /api/git/changes`` on the conversation's runtime.
- [Get Conversation Git Diff](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/get-conversation-git-diff.md): Proxy ``GET /api/git/diff`` on the conversation's runtime.
- [Get Conversation Skills](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/get-conversation-skills.md): Get all skills associated with the conversation.
- [Get Conversation Hooks](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/get-conversation-hooks.md): Get hooks currently configured in the workspace for this conversation.
- [Export Conversation](https://docs.openhands.dev/openhands/usage/cloud/api-reference/conversations/export-conversation.md): Download a conversation trajectory as a zip file.
- [Queue Pending Message](https://docs.openhands.dev/openhands/usage/cloud/api-reference/pending-messages/queue-pending-message.md): Queue a message for delivery when conversation becomes ready.
- [Search Sandboxes](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sandbox/search-sandboxes.md): Search / list sandboxes owned by the current user.
- [Batch Get Sandboxes](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sandbox/batch-get-sandboxes.md): Get a batch of sandboxes given their ids, returning null for any missing.
- [Start Sandbox](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sandbox/start-sandbox.md)
- [Pause Sandbox](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sandbox/pause-sandbox.md)
- [Resume Sandbox](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sandbox/resume-sandbox.md)
- [Delete Sandbox](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sandbox/delete-sandbox.md)
- [List Secret Names](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sandbox/list-secret-names.md): List available secret names (no raw values).
- [Get Secret Value](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sandbox/get-secret-value.md): Return a single secret value as plain text.
- [Search Sandbox Specs](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sandbox/search-sandbox-specs.md): Search / List sandbox specs.
- [Batch Get Sandbox Specs](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sandbox/batch-get-sandbox-specs.md): Get a batch of sandbox specs given their ids, returning null for any missing.
- [Load Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/settings/load-settings.md): Load user settings.
- [Store Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/settings/store-settings.md): Store user settings.
- [Load Settings Schema](https://docs.openhands.dev/openhands/usage/cloud/api-reference/settings/load-settings-schema.md): Load the schema for settings
- [Load Conversation Settings Schema](https://docs.openhands.dev/openhands/usage/cloud/api-reference/settings/load-conversation-settings-schema.md): Load the schema for conversations
- [List Profiles](https://docs.openhands.dev/openhands/usage/cloud/api-reference/settings/list-profiles.md): List all saved LLM profiles.
- [Get Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/settings/get-profile.md): Get a specific profile's configuration.
- [Save Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/settings/save-profile.md): Save an LLM configuration as a named profile.
- [Delete Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/settings/delete-profile.md): Delete a saved profile.
- [Activate Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/settings/activate-profile.md): Switch ``agent_settings.llm`` to use a saved profile.
- [Rename Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/settings/rename-profile.md): Rename a saved profile.
- [Store Provider Tokens](https://docs.openhands.dev/openhands/usage/cloud/api-reference/secrets/store-provider-tokens.md): Store git provider tokens.
- [Unset Provider Tokens](https://docs.openhands.dev/openhands/usage/cloud/api-reference/secrets/unset-provider-tokens.md): Unset (delete) all git provider tokens.
- [Search Custom Secrets](https://docs.openhands.dev/openhands/usage/cloud/api-reference/secrets/search-custom-secrets.md): Search / List custom secrets.
- [Create Custom Secret](https://docs.openhands.dev/openhands/usage/cloud/api-reference/secrets/create-custom-secret.md): Create or update a custom secret.
- [Update Custom Secret](https://docs.openhands.dev/openhands/usage/cloud/api-reference/secrets/update-custom-secret.md): Update a custom secret.
- [Delete Custom Secret](https://docs.openhands.dev/openhands/usage/cloud/api-reference/secrets/delete-custom-secret.md): Delete a custom secret.
- [Get Current User Git Info](https://docs.openhands.dev/openhands/usage/cloud/api-reference/user/get-current-user-git-info.md): Get the current authenticated user's metadata from the git provider.
- [Get Current User Saas](https://docs.openhands.dev/openhands/usage/cloud/api-reference/user/get-current-user-saas.md): Get the current authenticated user with SAAS-specific org info.
- [Get Current User Git Organizations](https://docs.openhands.dev/openhands/usage/cloud/api-reference/user/get-current-user-git-organizations.md): Return the Git organizations, groups, or workspaces the user belongs to on their active provider.
- [Search Skills](https://docs.openhands.dev/openhands/usage/cloud/api-reference/skills/search-skills.md): Search / list available global and user-level skills.
- [Get Marketplace Skills](https://docs.openhands.dev/openhands/usage/cloud/api-reference/skills/get-marketplace-skills.md): Get skills from marketplace repositories.
- [On Conversation Update](https://docs.openhands.dev/openhands/usage/cloud/api-reference/webhooks/on-conversation-update.md): Webhook callback for when a conversation starts, pauses, resumes, or deletes.
- [On Event](https://docs.openhands.dev/openhands/usage/cloud/api-reference/webhooks/on-event.md): Webhook callback for when event stream events occur.
- [Get Secret](https://docs.openhands.dev/openhands/usage/cloud/api-reference/webhooks/get-secret.md): Given an access token, retrieve a user secret. The access token is limited by user and provider type, and may include a timeout, limiting the damage in the event that a token is ever leaked
- [Get Web Client Config](https://docs.openhands.dev/openhands/usage/cloud/api-reference/config/get-web-client-config.md): Get the configuration of the web client.
- [Search Models](https://docs.openhands.dev/openhands/usage/cloud/api-reference/config/search-models.md): Search for LLM models with pagination and filtering.
- [Search Providers](https://docs.openhands.dev/openhands/usage/cloud/api-reference/config/search-providers.md): Search for LLM providers with pagination and filtering.
- [Search User Installations](https://docs.openhands.dev/openhands/usage/cloud/api-reference/git/search-user-installations.md): Get user installations (GitHub apps) or equivalent for other providers.
- [Search Repositories](https://docs.openhands.dev/openhands/usage/cloud/api-reference/git/search-repositories.md): Get or search repositories.
- [Search Branches](https://docs.openhands.dev/openhands/usage/cloud/api-reference/git/search-branches.md): Search branches in a repository.
- [Search Suggested Tasks](https://docs.openhands.dev/openhands/usage/cloud/api-reference/git/search-suggested-tasks.md): Get suggested tasks for the user.
- [Alive](https://docs.openhands.dev/openhands/usage/cloud/api-reference/status/alive.md): Endpoint for liveness probes.
- [Health](https://docs.openhands.dev/openhands/usage/cloud/api-reference/status/health.md): Health check endpoint.
- [Get Server Info](https://docs.openhands.dev/openhands/usage/cloud/api-reference/status/get-server-info.md): Server information endpoint.
- [Is Ready](https://docs.openhands.dev/openhands/usage/cloud/api-reference/is-ready.md)
- [Is Saas](https://docs.openhands.dev/openhands/usage/cloud/api-reference/is-saas.md)
- [Authenticate](https://docs.openhands.dev/openhands/usage/cloud/api-reference/authenticate.md)
- [Accept Tos](https://docs.openhands.dev/openhands/usage/cloud/api-reference/accept-tos.md)
- [Onboarding Status](https://docs.openhands.dev/openhands/usage/cloud/api-reference/onboarding-status.md): Return whether the current user must still complete onboarding.
- [Complete Onboarding](https://docs.openhands.dev/openhands/usage/cloud/api-reference/complete-onboarding.md): Mark onboarding as completed for the current user and fire analytics.
- [Logout](https://docs.openhands.dev/openhands/usage/cloud/api-reference/logout.md)
- [Refresh Tokens](https://docs.openhands.dev/openhands/usage/cloud/api-reference/refresh-tokens.md): Return the latest token for a given provider.
- [Keycloak Callback](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keycloak-callback.md)
- [Keycloak Offline Callback](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keycloak-offline-callback.md)
- [Github Dummy Callback](https://docs.openhands.dev/openhands/usage/cloud/api-reference/github-dummy-callback.md): Callback for GitHub that just forwards the user to the app base URL.
- [Device Authorization](https://docs.openhands.dev/openhands/usage/cloud/api-reference/device-authorization.md): Start device flow by generating device and user codes.
- [Device Token](https://docs.openhands.dev/openhands/usage/cloud/api-reference/device-token.md): Poll for a token until the user authorizes or the code expires.
- [Device Verification Authenticated](https://docs.openhands.dev/openhands/usage/cloud/api-reference/device-verification-authenticated.md): Process device verification for authenticated users (called by frontend).
- [Get User App Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/get-user-app-settings.md): Get the current user's app settings.
- [Update User App Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/update-user-app-settings.md): Update the current user's app settings (partial update).
- [Github Events](https://docs.openhands.dev/openhands/usage/cloud/api-reference/github-events.md)
- [Gitlab Events](https://docs.openhands.dev/openhands/usage/cloud/api-reference/gitlab-events.md)
- [Get Gitlab Resources](https://docs.openhands.dev/openhands/usage/cloud/api-reference/get-gitlab-resources.md): Get all GitLab projects and groups where the user has admin access.
- [Reinstall Gitlab Webhook](https://docs.openhands.dev/openhands/usage/cloud/api-reference/reinstall-gitlab-webhook.md): Reinstall GitLab webhook for a specific resource immediately.
- [Bitbucket Events](https://docs.openhands.dev/openhands/usage/cloud/api-reference/bitbucket-events.md)
- [List Pending Invitations](https://docs.openhands.dev/openhands/usage/cloud/api-reference/list-pending-invitations.md): List an organization's pending invitations, including invite links.
- [Create Invitation](https://docs.openhands.dev/openhands/usage/cloud/api-reference/create-invitation.md): Create organization invitations for multiple email addresses.
- [Revoke Invitation](https://docs.openhands.dev/openhands/usage/cloud/api-reference/revoke-invitation.md): Revoke a pending invitation, invalidating its token and invite link.
- [Accept Invitation Redirect](https://docs.openhands.dev/openhands/usage/cloud/api-reference/accept-invitation-redirect.md): Redirect invitation acceptance to frontend.
- [Accept Invitation](https://docs.openhands.dev/openhands/usage/cloud/api-reference/accept-invitation.md): Accept an organization invitation via authenticated POST request.
- [Install](https://docs.openhands.dev/openhands/usage/cloud/api-reference/install.md): Forward into Slack OAuth.
- [Install Callback](https://docs.openhands.dev/openhands/usage/cloud/api-reference/install-callback.md): Callback from slack authentication. Verifies, then forwards into keycloak authentication.
- [Keycloak Callback](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keycloak-callback-1.md)
- [On Event](https://docs.openhands.dev/openhands/usage/cloud/api-reference/on-event.md)
- [On Options Load](https://docs.openhands.dev/openhands/usage/cloud/api-reference/on-options-load.md): Handle external_select options loading (block_suggestion payload).
- [On Form Interaction](https://docs.openhands.dev/openhands/usage/cloud/api-reference/on-form-interaction.md): Handle repository selection form submission.
- [Jira Events](https://docs.openhands.dev/openhands/usage/cloud/api-reference/jira-events.md): Handle Jira webhook events.
- [Create Jira Workspace](https://docs.openhands.dev/openhands/usage/cloud/api-reference/create-jira-workspace.md): Create a new Jira workspace registration.
- [Get Current Workspace Link](https://docs.openhands.dev/openhands/usage/cloud/api-reference/get-current-workspace-link.md): Get current user's Jira integration details.
- [Create Workspace Link](https://docs.openhands.dev/openhands/usage/cloud/api-reference/create-workspace-link.md): Register a user mapping to a Jira workspace.
- [Jira Callback](https://docs.openhands.dev/openhands/usage/cloud/api-reference/jira-callback.md)
- [Unlink Workspace](https://docs.openhands.dev/openhands/usage/cloud/api-reference/unlink-workspace.md): Unlink user from Jira integration by setting status to inactive.
- [Validate Workspace Integration](https://docs.openhands.dev/openhands/usage/cloud/api-reference/validate-workspace-integration.md): Validate if the user's organization has an active Jira integration.
- [Update Email](https://docs.openhands.dev/openhands/usage/cloud/api-reference/update-email.md)
- [Resend Email Verification](https://docs.openhands.dev/openhands/usage/cloud/api-reference/resend-email-verification.md)
- [Verified Email](https://docs.openhands.dev/openhands/usage/cloud/api-reference/verified-email.md)
- [Get Credits](https://docs.openhands.dev/openhands/usage/cloud/api-reference/billing/get-credits.md)
- [Get Subscription Access](https://docs.openhands.dev/openhands/usage/cloud/api-reference/billing/get-subscription-access.md): Get details of the currently valid subscription for the user.
- [Has Payment Method](https://docs.openhands.dev/openhands/usage/cloud/api-reference/billing/has-payment-method.md)
- [Create Customer Setup Session](https://docs.openhands.dev/openhands/usage/cloud/api-reference/billing/create-customer-setup-session.md)
- [Create Checkout Session](https://docs.openhands.dev/openhands/usage/cloud/api-reference/billing/create-checkout-session.md)
- [Success Callback](https://docs.openhands.dev/openhands/usage/cloud/api-reference/billing/success-callback.md)
- [Cancel Callback](https://docs.openhands.dev/openhands/usage/cloud/api-reference/billing/cancel-callback.md)
- [Batch Get Shared Conversations](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sharing/batch-get-shared-conversations.md): Get a batch of shared conversations given their ids. Return None for any missing or non-shared.
- [Search Shared Events](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sharing/search-shared-events.md): Search / List events for a shared conversation.
- [Count Shared Events](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sharing/count-shared-events.md): Count events for a shared conversation matching the given filters.
- [Batch Get Shared Events](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sharing/batch-get-shared-events.md): Get a batch of events for a shared conversation given their ids, returning null for any missing event.
- [Get Shared Event](https://docs.openhands.dev/openhands/usage/cloud/api-reference/sharing/get-shared-event.md): Get a single event from a shared conversation by conversation_id and event_id.
- [Check Byor Permitted](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keys/check-byor-permitted.md): Check if BYOR key export is permitted for the request's effective org.
- [List Api Keys](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keys/list-api-keys.md): List API keys for the authenticated user in the effective org.
- [Create Api Key](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keys/create-api-key.md): Create a new API key for the authenticated user.
- [Delete Api Key](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keys/delete-api-key.md): Delete an API key, scoped to the effective org.
- [Get Current Api Key](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keys/get-current-api-key.md): Get information about the currently authenticated API key.
- [Refresh Managed Llm Api Key](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keys/refresh-managed-llm-api-key.md): Refresh the managed OpenHands LiteLLM key for the current user/org.
- [Get Llm Api Key For Byor](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keys/get-llm-api-key-for-byor.md): Get the LLM API key for BYOR (Bring Your Own Runtime).
- [Refresh Llm Api Key For Byor](https://docs.openhands.dev/openhands/usage/cloud/api-reference/keys/refresh-llm-api-key-for-byor.md): Refresh the LLM API key for BYOR (Bring Your Own Runtime).
- [Service Health](https://docs.openhands.dev/openhands/usage/cloud/api-reference/service/service-health.md): Health check endpoint for the service API.
- [Get Or Create Api Key For User](https://docs.openhands.dev/openhands/usage/cloud/api-reference/service/get-or-create-api-key-for-user.md): Get or create an API key for a user on behalf of the automations service.
- [Delete User Api Key](https://docs.openhands.dev/openhands/usage/cloud/api-reference/service/delete-user-api-key.md): Delete a system API key created by the service.
- [List User Orgs](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/list-user-orgs.md): List organizations for the authenticated user.
- [Create Org](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/create-org.md): Create a new organization.
- [Get Org Defaults Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org-defaults-settings.md): Get org-default settings for a specific organization.
- [Update Org Defaults Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/update-org-defaults-settings.md): Update org-default settings for a specific organization.
- [Get Legacy Org Defaults Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-legacy-org-defaults-settings.md): Get org-default settings through the deprecated ``/llm`` wrapper.
- [Update Legacy Org Defaults Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/update-legacy-org-defaults-settings.md): Update org-default settings through the deprecated ``/llm`` wrapper.
- [Get Org App Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org-app-settings.md): Get organization app settings for the user's current organization.
- [Update Org App Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/update-org-app-settings.md): Update organization app settings for the user's current organization.
- [Get Org](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org.md): Get organization details by ID through the deprecated detail route.
- [Delete Org](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/delete-org.md): Delete an organization.
- [Update Org](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/update-org.md): Update an existing organization.
- [Get Me](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-me.md): Get the current user's membership record for an organization.
- [Get Org Members](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org-members.md): Get all members of an organization with pagination and optional email filter.
- [Get Org Members Count](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org-members-count.md): Get count of organization members with optional email filter.
- [Get Org Members Financial](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org-members-financial.md): Get paginated financial data for organization members.
- [Get Org Budget Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org-budget-settings.md)
- [Update Org Budget Settings](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/update-org-budget-settings.md)
- [Upsert Org Budget Override](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/upsert-org-budget-override.md)
- [Delete Org Budget Override](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/delete-org-budget-override.md)
- [Remove Org Member](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/remove-org-member.md): Remove a member from an organization.
- [Update Org Member](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/update-org-member.md): Update a member's role in an organization.
- [Switch Org](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/switch-org.md): Switch to a different organization.
- [Get Git Claims](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-git-claims.md): Get all Git organization claims for an OpenHands organization.
- [Claim Git Organization](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/claim-git-organization.md): Claim a Git organization for an OpenHands organization.
- [Disconnect Git Organization](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/disconnect-git-organization.md): Remove a Git organization claim from an OpenHands organization.
- [List Org Conversations](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/list-org-conversations.md): List all conversations for an organization.
- [Get Org Conversation Stats](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org-conversation-stats.md): Get aggregated statistics for organization conversations.
- [Get Org Conversation Usage Stats](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org-conversation-usage-stats.md): Get detailed usage statistics for organization dashboard.
- [Get Org Conversation User Usage Stats](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org-conversation-user-usage-stats.md): Get per-user usage metrics for organization dashboard.
- [Export Org Conversations Csv](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/export-org-conversations-csv.md): Export organization conversations as CSV.
- [Get Org Conversation](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/get-org-conversation.md): Get a specific conversation by ID.
- [Stop Org Conversation](https://docs.openhands.dev/openhands/usage/cloud/api-reference/orgs/stop-org-conversation.md): Stop a running conversation and its runtime.
- [List Super Admins](https://docs.openhands.dev/openhands/usage/cloud/api-reference/admin/list-super-admins.md): List all current super admins. Requires ``MANAGE_SUPER_ADMINS``.
- [Grant Super Admin](https://docs.openhands.dev/openhands/usage/cloud/api-reference/admin/grant-super-admin.md): Grant the super-admin role to an existing user.
- [Revoke Super Admin](https://docs.openhands.dev/openhands/usage/cloud/api-reference/admin/revoke-super-admin.md): Revoke the super-admin role from a user (including oneself).
- [List Profiles](https://docs.openhands.dev/openhands/usage/cloud/api-reference/organization-profiles/list-profiles.md): List all LLM profiles for this organization.
- [Get Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/organization-profiles/get-profile.md): Get details of a specific profile.
- [Save Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/organization-profiles/save-profile.md): Create or update an LLM profile.
- [Delete Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/organization-profiles/delete-profile.md): Delete an LLM profile.
- [Activate Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/organization-profiles/activate-profile.md): Activate a profile for the current user.
- [Rename Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/organization-profiles/rename-profile.md): Rename an LLM profile, cascading the rename to any Agent Profiles that reference it.
- [List Agent Profiles](https://docs.openhands.dev/openhands/usage/cloud/api-reference/agent-profiles/list-agent-profiles.md): List agent profiles and the effective active pointer for this member.
- [Get Agent Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/agent-profiles/get-agent-profile.md): Get a stored profile — secret-free at rest, nothing to mask.
- [Save Agent Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/agent-profiles/save-agent-profile.md): Create or update an agent profile under ``name`` (path name is authoritative).
- [Delete Agent Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/agent-profiles/delete-agent-profile.md): Delete a profile (idempotent). Clears every org member's pointer to it.
- [Rename Agent Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/agent-profiles/rename-agent-profile.md): Rename a profile atomically.
- [Activate Agent Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/agent-profiles/activate-agent-profile.md): Activate a profile for the calling member — pointer only.
- [Materialize Agent Profile](https://docs.openhands.dev/openhands/usage/cloud/api-reference/agent-profiles/materialize-agent-profile.md): Dry-run resolve a profile's LLM/MCP references into a diagnostics report.
- [Search Verified Models](https://docs.openhands.dev/openhands/usage/cloud/api-reference/verified-models/search-verified-models.md): List all verified models, optionally filtered by provider.
- [Create Verified Model](https://docs.openhands.dev/openhands/usage/cloud/api-reference/verified-models/create-verified-model.md): Create a new verified model.
- [Update Verified Model](https://docs.openhands.dev/openhands/usage/cloud/api-reference/verified-models/update-verified-model.md): Update a verified model by provider and model name.
- [Delete Verified Model](https://docs.openhands.dev/openhands/usage/cloud/api-reference/verified-models/delete-verified-model.md): Delete a verified model by provider and model name.
- [Track Frontend Event](https://docs.openhands.dev/openhands/usage/cloud/api-reference/analytics/track-frontend-event.md): Capture a frontend-initiated analytics event.
- [OpenHands Enterprise](https://docs.openhands.dev/enterprise/index.md): Run AI coding agents on your own infrastructure with complete control
- [Enterprise vs. Open Source](https://docs.openhands.dev/enterprise/enterprise-vs-oss.md): Compare OpenHands Enterprise and Open Source offerings to choose the right option for your team
- [Sizing Guide](https://docs.openhands.dev/enterprise/sizing-guide.md): Recommended VM or Cluster sizing for an OpenHands Enterprise deployment
- [Quick Start](https://docs.openhands.dev/enterprise/quick-start.md): Get started with a 30-day trial of OpenHands Enterprise.
- [Custom Sandbox Images](https://docs.openhands.dev/enterprise/custom-sandbox-images/index.md): Prebake your repository, dependencies, and tooling into custom sandbox images so agents start on the actual task instead of spending time on setup.
- [Building a Custom Sandbox Image](https://docs.openhands.dev/enterprise/custom-sandbox-images/building-custom-images.md): How to build, version, and push a custom sandbox image for use with OpenHands Enterprise.
- [Configuring Custom Sandbox Images](https://docs.openhands.dev/enterprise/custom-sandbox-images/multiple-images-warm-pools.md): Configure custom sandbox images through the Runtime API, each kept ready in its own warm pool and independently selectable by users.
- [Single Image via Admin Console](https://docs.openhands.dev/enterprise/custom-sandbox-images/single-image-admin-console.md): Configure a single custom sandbox image for the whole installation through the Replicated Admin Console.
- [Using Custom Images](https://docs.openhands.dev/enterprise/custom-sandbox-images/using-custom-images.md): How users select a custom sandbox image and how to target a specific image per conversation via the API.
- [Running Docker in the Agent Sandbox](https://docs.openhands.dev/enterprise/docker-in-sandbox.md): Let agents run containers, Docker Compose, and image builds inside their isolated sandbox—safely, without privileged access to your cluster.
- [External PostgreSQL](https://docs.openhands.dev/enterprise/external-postgres.md): Configure OpenHands Enterprise to use your own PostgreSQL database
- [Troubleshooting](https://docs.openhands.dev/enterprise/troubleshooting.md): Collect diagnostics and inspect OpenHands Enterprise (OHE) workloads.
- [Conversations And Sandboxes](https://docs.openhands.dev/enterprise/conversations-and-sandboxes.md): Understand and manage conversation execution, sandbox placement, sharing, and lifecycle in OpenHands Enterprise.
- [Automations](https://docs.openhands.dev/enterprise/automations.md): Understand how automations are shared, who they run as, and who can manage them in an OpenHands Enterprise organization.
- [Skills and Plugins](https://docs.openhands.dev/enterprise/skills-and-plugins.md): Manage repository, organization, and user skills and control how plugins are discovered and loaded in OpenHands Enterprise.
- [Plugin Marketplace](https://docs.openhands.dev/enterprise/plugin-marketplace.md): Enable and configure the Plugin Marketplace to browse and install community-built OpenHands plugins.
- [Analytics](https://docs.openhands.dev/enterprise/analytics.md): Deploy Laminar for trace analysis in OpenHands Enterprise.
- [Organizations Overview](https://docs.openhands.dev/openhands/usage/cloud/organizations/overview.md): Manage teams and collaborate with shared resources in OpenHands Cloud or OpenHands Enterprise.
- [Managing Members](https://docs.openhands.dev/openhands/usage/cloud/organizations/managing-members.md): How to invite users and manage team members in your organization.
- [Roles and Permissions](https://docs.openhands.dev/openhands/usage/cloud/organizations/roles-permissions.md): Understanding the different permission levels in OpenHands Organizations.
- [Organization Settings](https://docs.openhands.dev/openhands/usage/cloud/organizations/settings.md): Configure shared resources and settings for your OpenHands organization.
- [Budgets](https://docs.openhands.dev/openhands/usage/cloud/organizations/budgets.md): Set spending limits for your organization and its members to keep AI spend under control.
- [OpenHands Enterprise 0.76.0](https://docs.openhands.dev/enterprise/release-notes/0.76.0.md): Release notes for OpenHands Enterprise version 0.76.0
- [OpenHands Enterprise 0.74.0](https://docs.openhands.dev/enterprise/release-notes/0.74.0.md): Release notes for OpenHands Enterprise version 0.74.0
- [OpenHands Enterprise 0.71.1](https://docs.openhands.dev/enterprise/release-notes/0.71.1.md): Release notes for OpenHands Enterprise version 0.71.1
- [OpenHands Enterprise 0.70.0](https://docs.openhands.dev/enterprise/release-notes/0.70.0.md): Release notes for OpenHands Enterprise version 0.70.0
- [OpenHands Enterprise 0.64.0](https://docs.openhands.dev/enterprise/release-notes/0.64.0.md): Release notes for OpenHands Enterprise version 0.64.0
- [OpenHands Enterprise 0.55.0](https://docs.openhands.dev/enterprise/release-notes/0.55.0.md): Release notes for OpenHands Enterprise version 0.55.0
- [OpenHands Enterprise 0.45.0](https://docs.openhands.dev/enterprise/release-notes/0.45.0.md): Release notes for OpenHands Enterprise version 0.45.0
- [OpenHands Enterprise 0.41.0](https://docs.openhands.dev/enterprise/release-notes/0.41.0.md): Release notes for OpenHands Enterprise version 0.41.0
- [OpenHands Enterprise 0.36.1](https://docs.openhands.dev/enterprise/release-notes/0.36.1.md): Release notes for OpenHands Enterprise version 0.36.1
- [OpenHands Enterprise 0.36.0](https://docs.openhands.dev/enterprise/release-notes/0.36.0.md): Release notes for OpenHands Enterprise version 0.36.0
- [OpenHands Enterprise 0.28.0](https://docs.openhands.dev/enterprise/release-notes/0.28.0.md): Release notes for OpenHands Enterprise version 0.28.0
- [OpenHands Enterprise 0.24.0](https://docs.openhands.dev/enterprise/release-notes/0.24.0.md): Release notes for OpenHands Enterprise version 0.24.0
- [Integrations Overview](https://docs.openhands.dev/enterprise/integrations/overview.md): Compare built-in integrations and MCP server integrations in OpenHands Enterprise, and see what each integration supports.
- [GitHub](https://docs.openhands.dev/enterprise/integrations/github.md): Configure the GitHub App and control the built-in GitHub resolver in OpenHands Enterprise.
- [GitLab](https://docs.openhands.dev/enterprise/integrations/gitlab.md): Configure GitLab authentication and repository webhooks for OpenHands Enterprise.
- [Azure DevOps](https://docs.openhands.dev/enterprise/integrations/azure-devops.md): Configure Azure DevOps authentication and automation triggers for OpenHands Enterprise.
- [Bitbucket Data Center](https://docs.openhands.dev/enterprise/integrations/bitbucket-data-center.md): Configure Bitbucket Data Center authentication and repository webhooks for OpenHands Enterprise.
- [Jira Cloud](https://docs.openhands.dev/enterprise/integrations/jira-cloud.md): Configure Jira Cloud for OpenHands Enterprise.
- [Jira Data Center](https://docs.openhands.dev/enterprise/integrations/jira-data-center.md): Configure Jira Data Center for OpenHands Enterprise.
- [SAML SSO](https://docs.openhands.dev/enterprise/integrations/saml-sso.md): Enable SAML single sign-on for OpenHands Enterprise and connect your corporate identity provider.
- [Authentik](https://docs.openhands.dev/enterprise/integrations/saml-providers/authentik.md): Configure Authentik as a SAML identity provider for OpenHands Enterprise.
- [Slack](https://docs.openhands.dev/enterprise/integrations/slack.md): Configure the Slack integration for a self-hosted OpenHands Enterprise install.
- [External LLM Gateways](https://docs.openhands.dev/enterprise/integrations/external-llm-gateways.md): Chain OpenHands Enterprise to an existing LiteLLM or Bifrost gateway so LLM traffic flows through your existing routing, cost tracking, and audit layer.
- [External Observability Platforms](https://docs.openhands.dev/enterprise/integrations/observability-platforms.md): Send OpenHands Enterprise conversation traces to your own OTLP-compatible observability platform such as Langfuse, Honeycomb, or Tempo.
- [Admin Console Configuration](https://docs.openhands.dev/enterprise/vm-install/admin-console-configuration.md): Configure an OpenHands Enterprise VM deployment from the Replicated Admin Console.
- [Log Collection](https://docs.openhands.dev/enterprise/vm-install/log-collection.md): Send logs from an OpenHands Enterprise VM installation to your own observability platform.
- [Scaling the Cluster](https://docs.openhands.dev/enterprise/vm-install/scaling.md): Add machines to an OpenHands Enterprise VM deployment to increase capacity, and run sandboxes on dedicated machines.
- [Kubernetes Installation](https://docs.openhands.dev/enterprise/k8s-install/index.md): Deploy OpenHands Enterprise into your own Kubernetes cluster using Helm
- [Install with Helm](https://docs.openhands.dev/enterprise/k8s-install/installation.md): End-to-end installation of OpenHands Enterprise on Kubernetes using Helm
- [Enable Automations with Helm](https://docs.openhands.dev/enterprise/k8s-install/automations.md): Configure the OpenHands Enterprise automation service on a Kubernetes installation.
- [Installing Sysbox](https://docs.openhands.dev/enterprise/k8s-install/sysbox.md): Install the Sysbox runtime so agent sandboxes can run securely
- [DNS and TLS](https://docs.openhands.dev/enterprise/k8s-install/dns-and-tls.md): Automate DNS records and TLS certificates with external-dns and cert-manager
- [Resource Limits](https://docs.openhands.dev/enterprise/k8s-install/resource-limits.md): Configure memory, CPU, and storage for OpenHands Enterprise components
- [Upgrade Guidance](https://docs.openhands.dev/enterprise/k8s-install/upgrade-guidance.md): Generic advice for upgrading a Kubernetes cluster running OpenHands Enterprise
- [Amazon EKS](https://docs.openhands.dev/enterprise/k8s-install/eks.md): Prepare an Amazon EKS cluster to run OpenHands Enterprise
- [Enterprise Cookbook](https://docs.openhands.dev/cookbook/index.md): Runnable examples for building on the OpenHands API with OpenHands Cloud or OpenHands Enterprise.
- [Conversation tags](https://docs.openhands.dev/cookbook/conversation-tags.md): Attach key-value metadata to a conversation with tags and read it back from AppConversation.tags.
- [Command blacklist](https://docs.openhands.dev/cookbook/command-blacklist.md): Block known-dangerous shell commands with a PreToolUse hook bundled in a plugin. Everything not on the blocklist runs normally.

## OpenAPI Specs

- [agent-sdk](/openapi/agent-sdk.json)
- [openhands-cloud](/openapi/openhands-cloud.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.