Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions openhands/usage/automations/creating-automations.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +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'?
---

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 @@ -47,6 +47,7 @@
- **What it should do**: Describe the task clearly
- **When it should run**: Daily, weekly, every hour, etc.
- **Timezone** (optional): Defaults to UTC if not specified
- **Run timeout** (optional): Defaults to 10 minutes; maximum 30 minutes
- **Name** (optional): The agent can suggest one based on your description
- **Plugins** (optional): Mention specific plugins if you need extended capabilities

Expand Down Expand Up @@ -120,12 +121,16 @@
- "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 124 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#L124

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 127 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#L127

Did you really mean 'cron'?

Check warning on line 127 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#L127

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

## Run Timeouts

Each run stops after its timeout. The default is 10 minutes; you can request up to 30 minutes, for example: "Use a 20-minute timeout."

## After Creation

Once your automation is created:
Expand Down
8 changes: 8 additions & 0 deletions openhands/usage/automations/managing-automations.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +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'?
---

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 @@ -43,6 +43,14 @@
Update the "Weekly Cleanup" automation to run on Sundays at 2 AM UTC
```

## Changing the Run Timeout

```
Set the "Weekly Cleanup" automation timeout to 20 minutes
```

Timeouts can be up to 30 minutes. Runs that exceed their timeout fail automatically.

## Running Manually

Test an automation or run it outside its normal schedule:
Expand Down Expand Up @@ -72,7 +80,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 83 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#L83

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

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

## Deleting Automations

Check warning on line 93 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#L93

Did you really mean 'Automations'?

```
Delete the "Old Report" automation
Expand Down
Loading