# Overview

## What is a Workflow?

A **workflow** in BroxiAI is an intelligent application that receives input, processes it through AI components, and produces meaningful output. Think of workflows as visual pipelines that connect different AI capabilities together.

<figure><img src="https://2739525811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGUcjvdv7MzVy7GYqImRT%2Fuploads%2FKnqor1tLzDOcquzVqTZ7%2FUntitled%20diagram%20_%20Mermaid%20Chart-2025-09-07-153938.png?alt=media&#x26;token=596f6c48-325a-4768-975e-02e162c24602" alt=""><figcaption></figcaption></figure>

Workflows are created in the **workspace** with components dragged from the components sidebar.

<figure><img src="https://2739525811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGUcjvdv7MzVy7GYqImRT%2Fuploads%2Fc7rtC9kb0y96oQ7lYVSg%2FScreenshot%202025-04-26%20at%2020.31.50.png?alt=media&#x26;token=70a1f8b2-4f3f-473c-a339-8b9a25779272" alt=""><figcaption></figcaption></figure>

A workflow can be as simple as a basic prompting flow, which creates an AI chatbot with four components, or as complex as a multi-agent system with dozens of interconnected components.

## Workflow Architecture

<figure><img src="https://2739525811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGUcjvdv7MzVy7GYqImRT%2Fuploads%2F3KFx0fUrbifHgRZ3L8x1%2FUntitled%20diagram%20_%20Mermaid%20Chart-2025-09-07-154010.png?alt=media&#x26;token=73d320f9-46e8-4555-86a1-60bcfb9c045e" alt=""><figcaption></figcaption></figure>

### Component Structure

* Each component in a workflow is a **node** that performs a specific task, like an AI model or a data source.
* Each component has a **Configuration** menu with customizable parameters.
* Components are connected with **edges** to form intelligent workflows.
* Data flows through the workflow following the connections you create.

### Find your way around <a href="#find-your-way-around" id="find-your-way-around"></a>

If you're new to BroxiAI, it's OK to feel a bit lost at first. We’ll take you on a tour, so you can orient yourself and start creating applications quickly.

BroxiAI has four distinct regions: the workspace is the main area where you build your flows. The components sidebar is on the left, and lists the available components. The playground and Publish pane are available in the upper right corner.

<figure><img src="https://2739525811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGUcjvdv7MzVy7GYqImRT%2Fuploads%2FxQ9kMUQcWKXTdRALsvLv%2FScreenshot%202025-04-26%20at%2020.37.31.png?alt=media&#x26;token=748b2712-468f-4dae-aa7d-d52f6082dfd2" alt=""><figcaption></figcaption></figure>

### Workspace

The **workspace** is where you create AI applications by connecting and running components in flows.

The workspace controls allow you to adjust your view and lock your flows in place.

* Add **Notes** to flows with the **Add Note** button, similar to commenting in code.
* To access the [Settings](https://use.broxi.ai/settings/general) menu, click **Settings**.

This menu contains configuration for **Global Variables**, **API Key**, **Shortcuts, Team** and **Messages**.

### Components <a href="#components" id="components"></a>

A **component** is a single building block within a flow and consists of inputs, outputs, and parameters that define its functionality.

To add a component to your flow, drag it from the sidebar onto the workspace.

To connect components, drag a line from the output handle (⚪) of one component to the input handle of another.

<img src="https://2739525811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGUcjvdv7MzVy7GYqImRT%2Fuploads%2FzesH7vlZz7FWdddCQN4v%2FScreenshot%202025-04-26%20at%2020.41.39.png?alt=media&#x26;token=0a07a1f1-36d1-4ad7-af7b-be3500d793dc" alt="Prompt component" data-size="original">

### Playground <a href="#playground" id="playground"></a>

The **Playground** executes the current flow in the workspace.

Chat with your flow, view inputs and outputs, and modify your AI's memories to tune your responses in real time.

Either the [**Chat Input** or **Chat Output**](https://guidenai.gitbook.io/broxi/input-and-output/chat-components) component can be opened in the [**Playground**](https://guidenai.gitbook.io/broxi/workflows/playground) and tested in real time.

For more information, see the Playground.

![](https://2739525811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGUcjvdv7MzVy7GYqImRT%2Fuploads%2F6Eh2X2L2jujzVQOqxgl7%2FScreenshot%202025-04-26%20at%2020.52.53.png?alt=media\&token=eadf3e63-a8b3-43d7-a141-e4cbadeaecdb)

### [API Access panel​](https://guidenai.gitbook.io/broxi/publish-workflow#api-access) <a href="#publish-pane" id="publish-pane"></a>

The **Publish** pane provides code templates to integrate your flows into external applications.

![](https://2739525811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGUcjvdv7MzVy7GYqImRT%2Fuploads%2Fca9bIkL3ZtDVBPyuC6EJ%2FScreenshot%202025-04-26%20at%2020.54.50.png?alt=media\&token=5b6aaf64-2bc8-4a08-a90a-3c2bc0499627)

### Projects and folders <a href="#projects-and-folders" id="projects-and-folders"></a>

The **My Projects** page displays all the flows and components you've created in the BroxiAI workspace.

![](https://2739525811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGUcjvdv7MzVy7GYqImRT%2Fuploads%2F59RIeDr3VTvXzB7px7kR%2FScreenshot%202025-04-26%20at%2020.56.26.png?alt=media\&token=5262f4c5-b244-4471-8ffc-db87b617356b)

**Primary** is the default folder where all new projects and components are initially stored.

Projects, folders, and flows are exchanged as JSON objects.

* To create a new folder, click 📁 **New Folder**.
* To rename a folder, double-click the folder name.
* To download a folder, click 📥 **Download**.
* To upload a folder, click 📤 **Upload**. The maximum file upload size is 100 MB.
* To move a flow or component, drag and drop it into the desired folder.

### File management <a href="#file-management" id="file-management"></a>

Upload, store, and manage files in [**File management**](https://guidenai.gitbook.io/broxi/workflows/file-manager) system.

For more on managing your files, see Manage files.

### Options menu <a href="#options-menu" id="options-menu"></a>

The dropdown menu labeled with the project name offers several management and customization options for the current flow in the workspace.

* **New**: Create a new flow from scratch.
* **Settings**: Adjust settings specific to the current flow, such as its name, description, and endpoint name.
* **Logs**: View logs for the current project, including execution history, errors, and other runtime events.
* **Import**: Import a flow or component from a JSON file into the workspace.
* **Export**: Export the current flow as a JSON file.
* **Undo (⌘Z)**: Revert the last action taken in the project.
* **Redo (⌘Y)**: Reapply a previously undone action.
* **Refresh All**: Refresh all components and delete cache.\\
