Skip to content
Merged
19 changes: 9 additions & 10 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,15 @@
"overview/skills/public"
]
},
{
"group": "Automations",
"pages": [
"openhands/usage/automations/overview",
"openhands/usage/automations/creating-automations",
"openhands/usage/automations/event-automations",
"openhands/usage/automations/managing-automations"
]
},
{
"group": "Settings",
"pages": [
Expand Down Expand Up @@ -420,16 +429,6 @@
"openhands/usage/cloud/organizations/roles-permissions",
"openhands/usage/cloud/organizations/settings"
]
},
{
"group": "Automations (BETA)",
"icon": "clock",
"pages": [
"openhands/usage/automations/overview",
"openhands/usage/automations/creating-automations",
"openhands/usage/automations/event-automations",
"openhands/usage/automations/managing-automations"
]
}
]
},
Expand Down
36 changes: 18 additions & 18 deletions enterprise/enterprise-vs-oss.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,53 @@
icon: scale-balanced
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One nit is to name this file enterprise vs local (instead of oss)

---

This page describes the key differences between **OpenHands Local GUI** (open source) for individual developers and small teams running the Local GUI on their own machines, and **OpenHands Enterprise** for organizations that need advanced collaboration, integrations, and management capabilities.
This page describes the key differences between **OpenHands Agent Canvas** (open source) for individual developers and small teams running the Agent Canvas on their own machines, and **OpenHands Enterprise** for organizations that need advanced collaboration, integrations, and management capabilities.
Copy link
Copy Markdown
Member

@malhotra5 malhotra5 May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe link to agent canvas repo?


## Feature Comparison

The table below highlights the key differences between the OpenHands Local GUI and OpenHands Enterprise offerings:
The table below highlights the key differences between the OpenHands Agent Canvas and OpenHands Enterprise offerings:

| Feature | Local GUI | OpenHands Enterprise |
| Feature | Agent Canvas | OpenHands Enterprise |
|---------|-------------------|----------------------|
| **Full breadth of agent functionality (sub-agents, MCP, skills, model agnosticism)** | ✅ | ✅ |
| **Where does the agent run?** | Local dev machines | Scalable, runtime sandboxes |
| **Scalability** *Run multiple concurrent agent conversations* | Limited by machine | Unlimited, on-demand |
| **'@OpenHands' in Slack and Jira** *Important for real-time resolution of bugs and feedback* | ❌ | ✅ |
| **'@OpenHands' in GitHub, GitLab, Bitbucket** *Important for real-time resolution of PR comments and failing tests* | ❌ | ✅ |
| **Multiple agent conversations in one place** *Give users visibility into all agent conversations* | | ✅ |
| **Share conversations** *Unlock collaboration use cases* | ❌ | ✅ |
| **Remote monitoring of agent conversations** *Enable Human-in-the-Loop operations for running agents* | ❌ Requires access to machine where agent is running | ✅ Monitor remotely from OpenHands Enterprise UI |
| **Multi-user management and RBAC** *Roll out to several users and teams* | ❌ | ✅ |
| **Automations** *Create scheduled and event-based workflows* | ❌ | ✅ |
| **Where does the agent run?** | Locally or on a custom backend | Scalable, Kubernetes runtimes |

Check warning on line 16 in enterprise/enterprise-vs-oss.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/enterprise-vs-oss.mdx#L16

Did you really mean 'runtimes'?
| **Automations** <br /> *Create scheduled and event-based workflows* | ✅ | ✅ |

Check warning on line 17 in enterprise/enterprise-vs-oss.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/enterprise-vs-oss.mdx#L17

Did you really mean 'Automations'?
Comment thread
jpelletier1 marked this conversation as resolved.
Comment thread
jpelletier1 marked this conversation as resolved.
| **'@OpenHands' in Slack and Jira** <br /> *Important for real-time resolution of bugs and feedback* | Requires custom [Automation](/openhands/usage/automations/overview) | Native integration |

Check warning on line 18 in enterprise/enterprise-vs-oss.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/enterprise-vs-oss.mdx#L18

Did you really mean 'Jira'?
| **'@OpenHands' in GitHub, GitLab, Bitbucket** <br /> *Important for real-time resolution of PR comments and failing tests* | Requires custom [Automation](/openhands/usage/automations/overview) | Native integration |
Comment thread
jpelletier1 marked this conversation as resolved.
| **Share conversations** <br /> *Unlock collaboration use cases* | | ✅ |
| **Multi-user Organizations and RBAC** <br /> *Roll out to several users and teams* | ❌ | ✅ |
| **User and Organization Budgets** <br /> *Monitor and control costs* | ❌ | ✅ |
| **Agent Observability Integrations** <br /> *Centralized logging of conversations* | ❌ | ✅ Uses Laminar|
| **Private Plugin Marketplace** <br /> *Publish reusable plugins for teams to use* | ❌ | ✅ |
| **SAML** | ❌ | ✅ |
| **REST APIs** | ❌ | ✅ |

## When to Choose Each Option

### OpenHands Local GUI
### OpenHands Agent Canvas

The OpenHands Local GUI is ideal for:
The OpenHands Agent Canvas is ideal for:

- Individual developers exploring AI-assisted coding
- Small teams with basic requirements
- Self-hosted environments where you manage your own infrastructure
- Running OpenHands locally on your own machine
- Running OpenHands locally on your own machine using the Agent Canvas

### OpenHands Enterprise

OpenHands Enterprise is the right choice when you need:

- **Team collaboration** — Share conversations and manage multiple users from a single platform
- **Multi-use RBAC** — Manage multiple users from a single platform
- **Platform integrations** — Invoke OpenHands directly from Slack, Jira, GitHub, GitLab, or Bitbucket

Check warning on line 44 in enterprise/enterprise-vs-oss.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

enterprise/enterprise-vs-oss.mdx#L44

Did you really mean 'Jira'?
- **Scalability** — Run unlimited parallel agent conversations without local resource constraints
- **Enterprise security** — SAML authentication, RBAC, and centralized audit logs
- **Remote monitoring** — Track agent progress in real-time from anywhere
- **Usage Monitoring** — Track and enforce budgets; monitor usage across all users

## Getting Started

<CardGroup cols={2}>
<Card
title="Try Local GUI"
title="Try Agent Canvas"
icon="desktop"
href="/openhands/usage/run-openhands/local-setup#start-the-app"
>
Expand Down
8 changes: 2 additions & 6 deletions openhands/usage/automations/creating-automations.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
---
title: Creating Automations

Check warning on line 2 in openhands/usage/automations/creating-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/creating-automations.mdx#L2

Did you really mean 'Automations'?
description: Learn how to create scheduled automations using the Automation Skill.

Check warning on line 3 in openhands/usage/automations/creating-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/creating-automations.mdx#L3

Did you really mean 'automations'?
---

<Info>
**Beta Feature**: Automations is currently in beta and available for **OpenHands Cloud** and **OpenHands Enterprise** users only.
</Info>

The easiest way to create an automation is to ask OpenHands directly. The Automation Skill handles all the details—you just describe what you want.

## Prompt vs Plugin Automations

Check warning on line 8 in openhands/usage/automations/creating-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/creating-automations.mdx#L8

Did you really mean 'Automations'?

There are two types of automations:

Check warning on line 10 in openhands/usage/automations/creating-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/creating-automations.mdx#L10

Did you really mean 'automations'?

<Tabs>
<Tab title="Prompt-based">
Most automations are prompt-based. Just describe the task in natural language:

Check warning on line 14 in openhands/usage/automations/creating-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/creating-automations.mdx#L14

Did you really mean 'automations'?

```
Create an automation called "Daily Standup Summary" that runs every weekday
Expand Down Expand Up @@ -81,7 +77,7 @@

Tell the automation what to do with its output:

- "Post to the #alerts Slack channel" (requires [Slack MCP](/openhands/usage/cloud/slack-installation))
- "Post to the #alerts Slack channel" (requires [Slack MCP](/openhands/usage/settings/mcp-settings))
- "Save to `reports/weekly-summary.md`"
- "Create a GitHub issue with the findings" (automatic if you logged in with GitHub)
- "Send a message via the configured notification service"
Expand Down Expand Up @@ -111,7 +107,7 @@
- **Your secrets**: Access API keys stored in Settings > Secrets
- **MCP integrations**: Use your configured MCP servers
- **Network access**: Make HTTP requests, connect to APIs
- **Git provider access**: Tokens from your Cloud login (GitHub, GitLab, or Bitbucket) are automatically included
- **Git provider access**: Tokens from your login (GitHub, GitLab, or Bitbucket) are automatically included

## Schedules

Expand All @@ -124,10 +120,10 @@
- "first day of each month"
- "twice a day at 9 AM and 5 PM"

The agent converts this to the appropriate cron schedule.

Check warning on line 123 in openhands/usage/automations/creating-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/creating-automations.mdx#L123

Did you really mean 'cron'?

<Tip>
If you're familiar with cron expressions, you can specify them directly: "Run on cron schedule `0 9 * * 1-5`"

Check warning on line 126 in openhands/usage/automations/creating-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/creating-automations.mdx#L126

Did you really mean 'cron'?

Check warning on line 126 in openhands/usage/automations/creating-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/creating-automations.mdx#L126

Did you really mean 'cron'?
</Tip>

## After Creation
Expand Down
8 changes: 3 additions & 5 deletions openhands/usage/automations/event-automations.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
---
title: Event-Based Automations

Check warning on line 2 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L2

Did you really mean 'Automations'?
description: Trigger automations from GitHub events or custom webhooks instead of cron schedules.

Check warning on line 3 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L3

Did you really mean 'automations'?

Check warning on line 3 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L3

Did you really mean 'cron'?
---

<Info>
**Beta Feature**: Event-based automations are in beta for **OpenHands Cloud** and **OpenHands Enterprise** users.
</Info>

Event-based automations run when something happens—a PR is opened, an issue is commented on, or a webhook fires—instead of on a schedule. This is ideal for responsive workflows like auto-reviewing PRs, triaging issues, or reacting to external service events.

Check warning on line 6 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L6

Did you really mean 'automations'?

Check warning on line 6 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L6

Did you really mean 'triaging'?

## Built-In vs. Custom Integrations

Expand All @@ -18,7 +14,7 @@

## GitHub Events (Built-In)

GitHub is a built-in integration. Create automations that respond to GitHub events without any webhook setup.

Check warning on line 17 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L17

Did you really mean 'automations'?

### Example: Auto-Review PRs with a Specific Label

Expand Down Expand Up @@ -85,19 +81,21 @@

## Custom Webhooks

For services beyond GitHub—like Linear, Stripe, or Slack—register a custom webhook first, then create automations that use it.

Check warning on line 84 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L84

Did you really mean 'automations'?

<Note>
**Two-phase workflow for custom webhooks:**

1. **Webhook registration (one-time setup)**: You execute the curl command yourself to register the webhook. This keeps your signing secrets secure—the agent provides the command but never handles your credentials directly.

2. **Automation creation (repeatable)**: Once the webhook is registered, the agent can create, update, and manage automations for that webhook source conversationally—no manual curl commands needed.

Check warning on line 91 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L91

Did you really mean 'automations'?
</Note>

### Walkthrough: Linear Integration

Check warning on line 94 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L94

Did you really mean 'Walkthrough'?

This example walks through setting up a Linear webhook to auto-triage new issues.
<Note>
Comment thread
jpelletier1 marked this conversation as resolved.
This example walks through setting up a Linear webhook to auto-triage new issues using Automations in **[OpenHands Cloud](https://app.all-hands.dev)**.

Check warning on line 97 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L97

Did you really mean 'Automations'?
</Note>

#### Step 1: Get Your Webhook Secret from Linear

Expand Down Expand Up @@ -138,7 +136,7 @@
The response includes a `webhook_url` that you'll configure in Linear.

<Accordion title="Understanding event_key_expr">
The `event_key_expr` is a JMESPath expression that extracts the event type from incoming webhook payloads. This extracted value is what you match against in the automation's `on` field.

Check warning on line 139 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L139

Did you really mean 'JMESPath'?

For example, Linear sends payloads like:
```json
Expand All @@ -161,7 +159,7 @@

#### Step 4: Create the Automation

Now the webhook is registered, the agent can create automations for you end-to-end. Just describe what you want:

Check warning on line 162 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L162

Did you really mean 'automations'?

```
Create an event-based automation called "Triage Linear Issues" that triggers
Expand All @@ -173,7 +171,7 @@

The agent creates the automation with:
- **Source**: `linear` (your registered webhook)
- **Event**: `Issue` (Linear's event type)

Check warning on line 174 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L174

Did you really mean 'Linear's'?
- **Filter**: `action == 'create'`

### Custom Webhook Parameters
Expand All @@ -184,7 +182,7 @@
|-----------|----------|-------------|
| `name` | Yes | Human-readable name |
| `source` | Yes | Unique identifier (lowercase, alphanumeric with hyphens) |
| `event_key_expr` | No | JMESPath to extract event type (default: `type`) |

Check warning on line 185 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L185

Did you really mean 'JMESPath'?
| `signature_header` | No | Header containing HMAC signature (default: `X-Signature-256`) |
| `webhook_secret` | No | Signing secret—provide yours or let the system generate one |

Expand All @@ -197,13 +195,13 @@
| Linear | `Linear-Signature` | `type` |
| Stripe | `Stripe-Signature` | `type` |
| Slack | `X-Slack-Signature` | `type` |
| Twilio | `X-Twilio-Signature` | `type` |

Check warning on line 198 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L198

Did you really mean 'Twilio'?

---

## Next Steps

New to automations? Start with the [Automations Overview](/openhands/usage/automations/overview) for the bigger picture, including cron-based scheduling and general concepts.

Check warning on line 204 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L204

Did you really mean 'automations'?

- [Automations Overview](/openhands/usage/automations/overview) — Cron-based automations and general concepts

Check warning on line 206 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L206

Did you really mean 'automations'?
- [Managing Automations](/openhands/usage/automations/managing-automations) — Update, disable, or delete automations

Check warning on line 207 in openhands/usage/automations/event-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/event-automations.mdx#L207

Did you really mean 'automations'?
4 changes: 0 additions & 4 deletions openhands/usage/automations/managing-automations.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
title: Managing Automations

Check warning on line 2 in openhands/usage/automations/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/managing-automations.mdx#L2

Did you really mean 'Automations'?
description: List, update, enable, disable, and delete your automations.

Check warning on line 3 in openhands/usage/automations/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/managing-automations.mdx#L3

Did you really mean 'automations'?
---

<Info>
**Beta Feature**: Automations is currently in beta and available for **OpenHands Cloud** and **OpenHands Enterprise** users only.
</Info>

You can manage your automations by asking OpenHands directly—just like you created them.

Check warning on line 6 in openhands/usage/automations/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/managing-automations.mdx#L6

Did you really mean 'automations'?

## Viewing Your Automations

Check warning on line 8 in openhands/usage/automations/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/managing-automations.mdx#L8

Did you really mean 'Automations'?

```
List my automations
Expand Down Expand Up @@ -76,7 +72,7 @@
- **Debug** if something went wrong

<Tip>
Automations are user-scoped, so all your automation runs appear alongside your regular conversations. Look for them in your conversations list after each scheduled run.

Check warning on line 75 in openhands/usage/automations/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/managing-automations.mdx#L75

Did you really mean 'Automations'?
</Tip>

### Run Statuses
Expand All @@ -86,7 +82,7 @@
- **Completed**: Finished successfully
- **Failed**: Something went wrong—check the run details

## Deleting Automations

Check warning on line 85 in openhands/usage/automations/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/managing-automations.mdx#L85

Did you really mean 'Automations'?

```
Delete the "Old Report" automation
Expand Down
37 changes: 10 additions & 27 deletions openhands/usage/automations/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,29 +1,25 @@
---
title: Automations Overview

Check warning on line 2 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L2

Did you really mean 'Automations'?
description: Create scheduled tasks that run automatically in OpenHands Cloud and Enterprise.
description: Create scheduled tasks that run automatically in OpenHands.
---

<Info>
**Beta Feature**: Automations is currently in beta and available for **OpenHands Cloud** and **OpenHands Enterprise** users only.
</Info>

Automations let you schedule AI-powered tasks that run automatically—daily reports, health checks, data syncs, and more. Each automation runs a full OpenHands conversation on your chosen schedule, with access to your LLM settings, stored secrets, and integrations.

Check warning on line 6 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L6

Did you really mean 'Automations'?

Your git provider credentials are automatically available—if you logged into OpenHands Cloud with GitHub, GitLab, or Bitbucket, that access is included by default.
Your git provider credentials are automatically available—if you logged into OpenHands with GitHub, GitLab, or Bitbucket, that access is included by default.

## What Can Automations Do?

Check warning on line 10 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L10

Did you really mean 'Automations'?

- **Generate reports**: Daily standups, weekly summaries, or monthly metrics

Check warning on line 12 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L12

Did you really mean 'standups'?
- **Monitor systems**: Check API health, SSL certificates, or uptime
- **Sync data**: Pull from external APIs, update spreadsheets, or refresh dashboards
- **Maintain code**: Run dependency checks, security scans, or cleanup tasks
- **Send notifications**: Post updates to Slack, create GitHub issues, or send alerts

<Note>
Automations can only interact with services you've configured access to. For example, posting to Slack requires the [Slack MCP integration](/openhands/usage/cloud/slack-installation). Git providers you logged in with (GitHub, GitLab, Bitbucket) are automatically available.
Automations can only interact with services you've configured access to. For example, posting to Slack requires the [Slack MCP integration](/openhands/usage/settings/mcp-settings). Git providers you logged in with (GitHub, GitLab, Bitbucket) are automatically available.

Check warning on line 19 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L19

Did you really mean 'Automations'?
</Note>

## Two Types of Automations

Check warning on line 22 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L22

Did you really mean 'Automations'?

When you ask OpenHands to create an automation, you can choose between:

Expand All @@ -42,7 +38,7 @@
our open GitHub issues, then posts the summary to #engineering on Slack.
```

For plugin-based automations, mention the plugin:

Check warning on line 41 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L41

Did you really mean 'automations'?

```
Create an automation using the code-review plugin that runs daily
Expand All @@ -65,27 +61,16 @@
3. The conversation is saved so you can review it later
4. You can even continue the conversation if needed

Automations are user-scoped—each automation and its runs belong to you. Conversations created by your automations automatically appear in your conversations list, just like any other conversation you start.

Check warning on line 64 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L64

Did you really mean 'Automations'?

Check warning on line 64 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L64

Did you really mean 'automations'?

Your automation has access to everything a normal OpenHands conversation does: terminal, file editing, your configured LLM, stored secrets, and MCP integrations. Git provider tokens from your Cloud login (GitHub, GitLab, or Bitbucket) are automatically included.
Your automation has access to everything a normal OpenHands conversation does: terminal, file editing, your configured LLM, stored secrets, and MCP integrations. Git provider tokens from your login (GitHub, GitLab, or Bitbucket) are automatically included.

## Getting Started

Before creating automations, complete this one-time setup:

### 1. Create an OpenHands API Key

Go to [Settings > API Keys](https://app.all-hands.dev/settings/api-keys) and create a new API key.

### 2. Save the API Key as a Secret

Copy the API key value and go to [Settings > Secrets](https://app.all-hands.dev/settings/secrets). Create a new secret with:
- **Name**: `OPENHANDS_API_KEY`
- **Value**: Your API key from step 1
**Prerequisites**
Comment thread
jpelletier1 marked this conversation as resolved.

This allows the Automation Skill to create and manage automations on your behalf.

### 3. Start a Conversation
- **Configured LLM** in your settings
- **Stored secrets** (optional) for any additional API keys your automations need (e.g., Slack tokens)

Check warning on line 73 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L73

Did you really mean 'automations'?

Open a new conversation in OpenHands and ask it to create an automation:

Expand All @@ -94,17 +79,15 @@
our open GitHub issues, then posts to #engineering on Slack.
```

You can also list existing automations, enable/disable them, or trigger manual runs—all through conversation.
Once you create an automation, you can view them by clicking on the "Automations" icon on the left-hand navigation.

Check warning on line 82 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L82

Did you really mean 'Automations'?

You can also ask OpenHands to list [existing automations, enable/disable them, or trigger manual runs](/openhands/usage/automations/managing-automations).

## Prerequisites

- **OpenHands Cloud or Enterprise account** (not available in open-source)
- **Configured LLM** in your [settings](https://app.all-hands.dev/settings)
- **Stored secrets** (optional) for any additional API keys your automations need (e.g., Slack tokens)

---

## Use Case Automations

Check warning on line 90 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L90

Did you really mean 'Automations'?

{/* BEGIN:use-case-automations — auto-generated from use-case frontmatter */}

Expand Down Expand Up @@ -267,5 +250,5 @@
## Next Steps

- [Creating Automations](/openhands/usage/automations/creating-automations) — More details on writing prompts
- [Managing Automations](/openhands/usage/automations/managing-automations) — Update, disable, or delete automations

Check warning on line 253 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L253

Did you really mean 'automations'?
- [Use Cases Overview](/openhands/usage/use-cases/overview) — Explore the full use case guides behind these automations

Check warning on line 254 in openhands/usage/automations/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/automations/overview.mdx#L254

Did you really mean 'automations'?
Loading