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
8 changes: 8 additions & 0 deletions openhands/usage/agent-canvas/conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ description: Work with Agent Canvas conversations, including branching from prev

A conversation is a single agent session on the active backend. It has its own message history, tool calls, file changes, selected agent profile, and conversation-specific plugins.

## Follow Agent Activity

While an agent is running, the composer shows a live activity chip for its current unresolved action, such as reading a file or running a command. If no action-specific label is available, it shows `Thinking`. The chip disappears when the agent pauses or completes its work.

## Handle a Failed Message

If a message fails to send, select `Retry` to send it again or `Dismiss` to remove the failed message bubble. Dismissing a message does not restore its text to the composer.

## Branch From a Message

Use `Branch from here` on a message when you want to explore a different path without changing the original conversation.
Expand Down
4 changes: 4 additions & 0 deletions openhands/usage/agent-canvas/managing-automations.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: Managing automations

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

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

Did you really mean 'automations'?
description: Browse, export, import, enable, disable, and run automations from the Agent Canvas Automate view.

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

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

Did you really mean 'automations'?
---

The **Automate** view in Agent Canvas is the in-app control center for your automations. From here you can see all automations on the active backend, inspect their configuration and run history, and manage their lifecycle without leaving the app.

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

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

Did you really mean 'automations'?

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

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

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

Did you really mean 'automations'?

<Note>
Automations run on the active backend. Switch backends from [Connect and Manage Backends](/openhands/usage/agent-canvas/backends) to see automations on a different backend.

Check warning on line 9 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L9

Did you really mean 'Automations'?

Check warning on line 9 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L9

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

## Browse and inspect automations

Check warning on line 12 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L12

Did you really mean 'automations'?

Open the **Automate** tab in the sidebar to see all automations on the active backend. Each row shows the automation name, trigger type, and enabled state.

Check warning on line 14 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L14

Did you really mean 'automations'?

Click an automation to open its detail view. The detail view shows:

Expand All @@ -20,9 +20,13 @@
- LLM profile used for runs
- Recent run history and status

### Run Statuses

A run can be `PENDING`, `RUNNING`, `COMPLETED`, `FAILED`, `CANCELLED`, or `SKIPPED`. A `SKIPPED` run can occur when the backend reaches its concurrency limit. Future backend statuses appear as a neutral status badge so they do not prevent you from viewing the automation.

## Enable and disable automations

Check warning on line 27 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L27

Did you really mean 'automations'?

Toggle an automation on or off from the kebab menu (⋮) on the automation row, or from the detail view. Disabled automations do not fire on their scheduled trigger or in response to events, but their configuration is preserved.

Check warning on line 29 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L29

Did you really mean 'automations'?

## Run an automation manually

Expand Down Expand Up @@ -82,7 +86,7 @@
4. Review the preview — it shows the automation's name, trigger type, and prompt.
5. Confirm to create the automation.

Imported automations are created **disabled**. After importing, open the automation from the list, review its configuration, and enable it when ready.

Check warning on line 89 in openhands/usage/agent-canvas/managing-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/managing-automations.mdx#L89

Did you really mean 'automations'?

## Related guides

Expand Down
6 changes: 4 additions & 2 deletions openhands/usage/agent-canvas/prebuilt-automations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
description: Get started quickly with a pre-built automation for common workflows.
---

Agent Canvas ships with a set of pre-built automations for the most common agent workflows. Each one is a ready-to-use starting point — pick the one that fits your use case, connect it to the right backend, and you can have an automation running in minutes.

Check warning on line 6 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L6

Did you really mean 'automations'?

## Available Pre-built Automations

Check warning on line 8 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L8

Did you really mean 'Automations'?

| Automation | What It Does |
|------------|-------------|
Expand All @@ -21,24 +21,26 @@

In the `Automate` view, you can:

- Browse existing automations

Check warning on line 24 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L24

Did you really mean 'automations'?
- Inspect automation configuration and activity
- Enable or disable automations

Check warning on line 26 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L26

Did you really mean 'automations'?
- Edit an automation's LLM profile for future runs
- Work with recommended automation flows

## How Creation Flows Usually Start

The `Automations` view is mainly for browsing and managing automations that already exist.

Check warning on line 32 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L32

Did you really mean 'automations'?

In practice, new automation setup often starts in one of two ways:
In practice, new automation setup starts in one of two ways:

- From a conversation, where you ask OpenHands to create an automation for you
- From a conversation, where you ask OpenHands to `create an automation` for you
- From a recommended automation flow in the `Automations` view

For recommended automations that support a direct form setup, Agent Canvas checks the active backend's capabilities and any prerequisites, then guides you through the required input fields, a review step, and creation. If direct form setup is unavailable, it offers a conversation-assisted setup instead. Review the proposed configuration before creating an automation.

Check warning on line 39 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L39

Did you really mean 'automations'?

Check warning on line 39 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L39

Did you really mean 'backend's'?

For a detailed walkthrough, see [Creating Automations](/openhands/usage/automations/creating-automations).

Check warning on line 41 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L41

Did you really mean 'walkthrough'?

Automations run against the active backend. Use [Manage Backends](/openhands/usage/agent-canvas/backends) to see and switch which backend your automations run on.

Check warning on line 43 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L43

Did you really mean 'Automations'?

Check warning on line 43 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L43

Did you really mean 'automations'?

## Edit an Automation's LLM Profile

Expand Down
Loading