Overview
The following is the basic process for using workflows.
Create
Workflows can be created in two ways.
Blank

After clicking Create Workflow, click Blank Workflow on the left.

This way, you will create a completely blank workflow.
- Name: It is recommended to use camel case for naming.
- Description: The workflow description is very important; please write it carefully, as it will affect the LLM's recognition and judgment when calling this workflow. You can clearly describe the main task and objectives of this workflow here. For example, "
Get today's news list.".
Create By Templates

After clicking Create Workflow, on the right side, GPTBots officially provides various types of workflow templates. First, select a category.

Then, you can select a suitable template to create an out-of-the-box workflow with a single click.
If you don't find the template you need, you can contact us via email (support@gptbots.ai), and our professional technical support team can create a template for you.
Orchestrate
This section introduces the basic operations within the workflow canvas.
Add Node
Currently, there are multiple ways to add nodes.
Add as Downstream Node

Clicking the output port of a node will open a menu.

Clicking a component in the menu will add it as a downstream node to the current node.
Node Insert

Click the Add button in the middle of the node connection line to open the menu.

Clicking a component in the menu allows you to add a new node as an intermediate node between two existing nodes, easily performing a node insertion operation.
Add to Canva

From the menu in the bottom toolbar, click a component to add it to the canvas as a node.
Connect Nodes

Click and hold the output port of the upstream node, then drag the line to the target downstream node and release to complete the connection.
Config Node

Clicking the node card itself will open the node configuration panel in the sidebar.
Configuring node information on the configuration panel is automatically saved, so there is no need to manually save.
Delete Node

Two ways to delete a node:
- Click the menu in the top right corner of the node and select Delete.
- After clicking to select the node card, press Backspace or Del on the keyboard.
Note that when a node is deleted, all its upstream and downstream connections will be broken, so please proceed with caution.
Test
Before officially publishing a workflow, it is recommended to test it first. Publish only after testing is successful to ensure the workflow operates as expected.
Node Test

Workflows support independent testing for individual nodes. After configuring a node, click Node Test to open the test panel.

In the test panel, enter your test values and click Run.

The test panel will return the results of this node test.
Trial Run
A trial run is a test for the entire workflow, executing the complete workflow once.

Click Trial Run to open the test panel.
In the test panel, enter your test values and click Run.

The workflow will start running, and you can see the complete data flow on the canvas, as well as the execution status of each node in this test.

Finally, in the test panel, you will see the return results of this trial run.
At the same time, by clicking on the status bar of each node, you can also view the input and output of each node in this test.
Save

GPTBots workflows are automatically saved during your orchestration and configuration process, so you don't need to worry about data loss.
However, you can still save manually. Click Save Only to record it as a draft version.
The advantage of doing this is that you can later roll back the workflow to this draft version.
Publish
A workflow needs to be published to be officially used.

Click Publish, edit the version number, write the update log, and click Publish to complete the publication.
Apply
Workflows can be applied in multiple scenarios; see subsequent documentation for details.
| Integration | Description |
|---|---|
| API | Workflows can be called as APIs. |
| Sharing Page | Use workflows via a web page and share them with others. |
| Workspace | Use workflows within the GPTBots workspace to improve work efficiency. |
| Zapier | To be added... |
| N8n | To be added... |
| Dify | To be added... |
