> For the complete documentation index, see [llms.txt](https://docs.aisera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aisera.com/aisera-platform/ai-automation-optimize-flow/hyperflow-studio/creating-a-hyperflow.md).

# Creating a Hyperflow

When you use a [**Hyperflow**](https://aisera.com/platform/hyperflows/), you designate the sources to integrate with, add **Functions**, and then specify information about the parameters that are required for that function/integration combination.

### **To create a Hyperflow:**

1. Choose **Hyperflows** from the left navigation menu in the Aisera Administration application.

   <figure><img src="/files/coYBnUgxE7DHcjX6TMAU" alt=""><figcaption></figcaption></figure>

2. Select the **+ New Hyperflow** button in the upper-right corner.

3. Fill in the **Name**, **Description**, and **Use Cases** parameters.

4. Click the **+ Add Functions** button.

5. In the **Add Functions** window, select a **Function** from the drop-down menu.

   **NOTE:** To add a a **Function** to the **Hyperflow**, the Hyperflow must be in **Draft** model.

   <div align="left"><figure><img src="/files/Qp4r0yl4QOYeJCB4dB6n" alt=""><figcaption></figcaption></figure></div>

6. Select **Actions** for your **Function** and click the **Next** button. \
   **Note:** You can choose more than one **Action.**<br>

   <div align="left"><figure><img src="/files/rP6HrcqQaz2oFePnjkpn" alt="" width="235"><figcaption></figcaption></figure></div>

7. Add [parameters for each of the **Actions**](https://docs.aisera.com/aisera-platform/ai-automation-optimize-flow/ai-workflow-studio/building-workflows/using-workflow-actions) that are part of the **Function**. <br>

   <div align="left"><figure><img src="/files/NvEXB9YDFpR2Hegg46v5" alt="" width="563"><figcaption></figcaption></figure></div>

8. While **Actions** support most interactions with supported external systems, **custom APIs** (Postman collections) can be imported to any Integrated and used as a Function.

   <div align="left"><figure><img src="/files/b83aZ3roE8Jp7LG5z1eP" alt="" width="245"><figcaption><p>APIs can be imported to any integration<br></p></figcaption></figure></div>

   <div align="left"><figure><img src="/files/nrk1EDqME2hmnNMG1qie" alt="" width="345"><figcaption><p>APIs can be imported using Postman collections<br></p></figcaption></figure></div>

   <div align="left"><figure><img src="/files/9buqWhmes451vOH9TvrM" alt=""><figcaption><p>Integrations can have a mix of out-of-box Actions and custom APIs<br></p></figcaption></figure></div>

9. Additionally, any **Workflow** can be used as a **Function**. This gives your agentic automation limitless capabilities.

10. After you've added all of the parameters for your **Actions**, **APIs** or **Workflow** the **Function** is complete.

<figure><img src="/files/p6N3XlabVLUo7LgUg7Xw" alt=""><figcaption></figcaption></figure>

### Test Your Hyperflow

Use the **Test** button to run the workflow. After you select the **Test** button, you can add a query to tset the parameters that run the workflow.

<div align="left"><figure><img src="/files/x1CCbq4Qta1vmM9RcUOO" alt="" width="563"><figcaption></figcaption></figure></div>

### Publish a Hyperflow

Add a **Version** and a **Description** to your workflow after you select the **Publish** buttn.

<div align="left"><figure><img src="/files/nRPqy3AI6U9UElfuXado" alt="" width="563"><figcaption></figcaption></figure></div>

### Create Another Draft Version

After your workflow is published, you can still **Test** it or create a new **Draft** version.

<div align="left"><figure><img src="/files/6HjpwWde2p3nOpTMRw1A" alt="" width="308"><figcaption></figcaption></figure></div>

### Registered Hyperflows appear in the Used By Column of Workflows

You can register Hyperflows or Workflow to associate them with a specific application or bot. \
The process to register a Hyperflow is the same as the process to register a Workflow. See [**Register a Workflow for Bot Conversational Triggers**](https://docs.aisera.com/aisera-platform/ai-automation-optimize-flow/ai-workflow-studio/register-a-workflow-for-bot-conversational-triggers).\
\
Hyperflows appear in the **Used By** Column of Workflows.

<figure><img src="https://docs.aisera.com/~gitbook/image?url=https%3A%2F%2F2983236984-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FiZkLJr3EjXkd2tHYiQJP%252Fuploads%252FvfcJFuDHwMucmLd3bSWp%252Frn_6.png%3Falt%3Dmedia%26token%3D03ca7e62-bdeb-4069-8eca-f8485576a4a4&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=c81d26d6&#x26;sv=2" alt=""><figcaption></figcaption></figure>

### **Hyperflows Validate Registration Before Deletion**

If you attempt to delete a registered Hyperflow (Hyperflow associated with a specific application/bot) you will receive the following message in the Aisera Admin UI: `This Hyperflow cannot be deleted because it is currently registered in the application. Please remove it from the Registered Flows before attempting deletion.`

### **Go Back Option in Hyperflows**

The **Go Back** option is now available for use in a Workflow when it is being executed through the Hyperflow.

## **Hyperflow Function Authentication (OAuth)**

**Hyperflows** includes the ability to execute the **API**s/**Actions/Workflows** associated with an integration as the user who is logged into the channel of interaction. For instance, if you are using the **Aisera Webchat** channel, the **Hyperflow** function authentication will be performed (OAuth) for the user logged into that channel.

## **Context Switching**

If the user switches context which is out of scope for the Hyperflow, the next best fulfillment will be used to respond to the user's request.

## Create a Hyperflow Using a Postman Collection

In addition to creating **Hyperflow** with the Aisera Admin UI, as discussed above, you can use Aisera's curated **Postman Collections** of to build Hyperflows.

Import, explore, and customize your data using Postman. Then, export your data and use the Aisera Admin UI to import it into your integrated systems for use with **Hyperflows**.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.aisera.com/aisera-platform/ai-automation-optimize-flow/hyperflow-studio/creating-a-hyperflow.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
