# Test Flow editor

API Test flow is a series of API calls (HTTP requests) that represent **a single "user" flow you would like to test**. These requests will be executed sequentially until completion or until the first failure.

![](https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-00dfe88459ee23e576a2c71d58e0a8c6d3d2b835%2FScreenshot%20\(19\).png?alt=media)

{% hint style="info" %}
🧠 Control visibility of the flows' list area by clicking on Flows in the Test Suite navigation panel. This way you can better focus on the flow you are currently working on.
{% endhint %}

## The Test Flow Toolbar

<figure><img src="https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-830a9829125c569265e14c6e8eebb55c3450b04e%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

| Option                                                                                                                                                                                                                                                                                                                           | Description                                                                                                                                                                                                          |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| AutoSave <img src="https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-0015e1442fc0f41c3520b26fcebaf74f6542f7cb%2FScreen%20Shot%202020-11-26%20at%2014.20.04.png?alt=media&#x26;token=98183143-1e5b-4f33-b3f3-97b36e27bd62" alt="" data-size="line"> | Auto saves the test flow unless its configuration is invalid.                                                                                                                                                        |
| Login toggle                                                                                                                                                                                                                                                                                                                     | Toggle this switch to enable the flow to use [the Global Login](https://docs.loadmill.com/api-testing/test-suite-editor/global-login-flow) settings.                                                                 |
| CSV toggle                                                                                                                                                                                                                                                                                                                       | Easily re-run your test flows by using different parameters values by uploading a [CSV file](https://docs.loadmill.com/api-testing/test-suite-editor/api-tests-data-from-csv-files) containing a list of the values. |
| Flow status (default: ![](https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-56a42b1c9d6c3a000013dc65fe07e788bfc9b78b%2Fimage.png?alt=media))                                                                                                       | Set the [status of the flow](https://docs.loadmill.com/general/api-testing1/analyzing-an-api-test-results#flow-status).                                                                                              |
| Run Flow button (![](https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-34615741314a87ba030bb44d663304f9794e573f%2Fimage.png?alt=media))                                                                                                            | Run the edited flow as a "Trial run" to debug and validate it.                                                                                                                                                       |
| Run with overrides (![](https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-cc9d365f5634c01512000d4ce0177ae780835424%2Fimage.png?alt=media))                                                                                                         | Run the edited flow as usual, but [override some parameters](https://docs.loadmill.com/test-editor/flows/flow-execution#runnning-with-overrides).                                                                    |
| Debug mode toggle (![](https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-27baf1245bb79ab83fffa8b72b4deb6480633883%2Fimage.png?alt=media))                                                                                                          | Turn the [Debug Mode](https://docs.loadmill.com/test-editor/flows/flow-controls#debug-mode) on/off.                                                                                                                  |
| Flow scope parameters (![](https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-f8c859af3fc9a345b90b8f80f9cb2a76273b68db%2Fimage.png?alt=media))                                                                                                      | Set parameters which can be used in a specific flow.                                                                                                                                                                 |
| Edit flow code (![](https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-86849d279608453a1c72e6f6a3d35163f8079bbc%2Fimage.png?alt=media))                                                                                                             | Edit the raw YAML code of the saved flow.                                                                                                                                                                            |
| Edit using AI (![](https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-9e4353f323752a6279887d00965eb2a3b2f8e62d%2Fimage.png?alt=media))                                                                                                              | Describe the desired changes and get a suggestion made by AI.                                                                                                                                                        |
| Restore deleted requests (![](https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-4d0a35a95495a792868a15930b51bdb75e693510%2Fimage.png?alt=media))                                                                                                   | Allows to restore previously deleted requests (up to 10 requests), and the restoration stack clears upon refreshing the page.                                                                                        |
| Add request                                                                                                                                                                                                                                                                                                                      | Add en empty request to the flow                                                                                                                                                                                     |
| Paste requests                                                                                                                                                                                                                                                                                                                   | Paste a request - accepts CURL, and copied requests from the flow.                                                                                                                                                   |

<figure><img src="https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-f52ed2199d2a6629dcf056b3972b96f75d62218d%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

| Option                       | Description                                                                                                                                                                                |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Export Flow                  | Save the flow to a YAML file. You can then import the flow into another test suite or as a load test.                                                                                      |
| Duplicate Flow               | Create a copy of the original flow within the Test Suite.                                                                                                                                  |
| Convert to Load Test         | Converts the flow to a [Load Test](#converting-api-flow-to-load-test).                                                                                                                     |
| Replace Parameter            | Replace the usage of a parameter in this flow with another parameter. (Find more information about parameters [here](https://docs.loadmill.com/api-testing/test-suite-editor/parameters)). |
| Extract Parameter            | Extract a value to a parameter from all across the test requests.                                                                                                                          |
| Copy Flow to Suite           | Copy the flow into another Test Suite.                                                                                                                                                     |
| Generate Descriptions        | Generate a suitable description to all requests in a flow using AI.                                                                                                                        |
| Configure service Definition | For GRPC, allows selecting the service that will be used in the flow.                                                                                                                      |
| Get Last Trial Run           | Open the last run's results window.                                                                                                                                                        |

### **Converting API flow to Load Test**

Easily convert an API flow to Load test by clicking on the Flow options and select "Convert to Load Test". Once you've selected ![](https://684333474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LHDbUNdi3wPd9vSolzU%2Fuploads%2Fgit-blob-a3d05604de169649f739f93163151f13f6ae3d89%2Fimage%20\(142\).png?alt=media), a new Load test will open containing all the requests and properties taken from the original API test.
