API Testing: Flows
Overview
Use this page to search for and run API testing flows. A flow is an ordered sequence of request and action steps, such as logging in, capturing a token, and calling an endpoint, that you execute together as one test. This lets you validate or load-test a multi-step API interaction without repeating the setup by hand each time.
A flow is usually built from or linked to an API source, an imported API definition managed on API Testing: API Sources, and it runs against an environment configured on API Testing: Environments. Flows that need authentication can draw on profiles from API Testing: Auth Profiles. Once a flow exists, you can schedule it on API Testing: Schedules, and its runs are recorded on API Testing: Run History.
This page itself lets you search and filter flows by name, source, reusable status, or recent impact, create one from scratch, import it, generate it with AI, or start from a login-and-token template, and manage each flow's steps, schedule, export, or deletion from its row.
Key concepts
- flow - An ordered sequence of request and action steps, such as a login call, a token capture, and a protected request, that runs as a single test. (related: API Testing: Run History)
- Source - The imported API definition, such as an OpenAPI or Swagger document, that a flow was generated from or is linked to. (related: API Testing: API Sources)
- Reusable - A flag on a flow that marks it as a shared step sequence other flows can reference, so a change to it can affect every flow that calls it.
- Impacted only - A filter that narrows the list to flows affected by a recent change elsewhere, such as an update to a reusable flow they depend on.
When to use it
- You need to find a specific flow by name, source, or reusable status before editing or running it.
- You want to start a run against a flow on demand, for example to check an API right after a deployment.
- You are setting up a test for a protected API and want a ready-made login-and-token sequence instead of wiring up authentication by hand.
- A reusable flow changed and you need to see which other flows are impacted and re-check them.
- You want to import a flow from a shared library or generate one with AI instead of building it step by step.
- You need to schedule, export, or delete an existing flow.
Before you begin
- An API source (an imported OpenAPI or Swagger definition) exists on API Testing: API Sources, if you want a flow tied to a specific API.
- At least one environment is configured on API Testing: Environments, since starting a run requires choosing an environment to run against.
- If the flow needs to authenticate, an auth profile exists on API Testing: Auth Profiles, or you plan to build the login steps directly into the flow with Login & reuse token.
- Your account has flow-management permissions; a read-only role can view this list but cannot create, import, schedule, export, or delete a flow.
Common workflows
Find and run an existing flow
Persona: Load-test operator
- Type the flow name into the Search box and select Search.
- Expect: The table reloads to show only flows whose name matches the text you typed.
- Select the matching flow's Name link.
- Expect: The Run dialog opens for that flow.
- Choose an environment in the dialog and select Start Run.
- Expect: The run launches and the dialog closes or shows progress.
Verify: The flow's Last Run column shows a new outcome and timestamp once the run finishes; check API Testing: Run History if you need the full result.
Build an authenticated flow with Login & reuse token
Persona: Admin setting up a new protected-API test
- Select Login & reuse token in the header.
- Expect: A new flow is created immediately, pre-filled with a login step, a capture-token step, and a protected request step, and opens in the editor.
- Adjust the login and protected request details for your API in the editor, then save.
- Expect: The flow's steps update to match your API and the flow remains in the list.
Verify: The flow appears in the table with a Status of Active and a Nodes count that reflects the login, token-capture, and protected request steps, ready to run or schedule.
Steps
Step 1
Open Flows under API Testing.
Expected result: The API Flows page loads with the flow list, search and filter controls, and the header actions for adding a new flow.
This is the entry point for finding, running, and managing all API testing flows.
- Create New, Import, Generate with AI, Blank, and Login & reuse token sit above the table as the ways to add a flow.
- Search, Source, Reusable, and Impacted only sit above the table to narrow the list.
- Each row's Actions column holds four icons for settings, schedule, export/duplicate, and delete.
Field reference
| Field | Purpose | Format / Validation | Required | Default |
|---|---|---|---|---|
| Search | Free-text filter that narrows the list to flows whose name matches the text you type, so you can jump straight to a known flow instead of scanning the table. | free text | No | - |
| Source | Narrows the list to flows built from or linked to a specific API source. Choose All Sources to see flows across every imported API definition, or pick one source to isolate flows scoped to that API only. | dropdown | No | All Sources |
| Reusable | Filters flows by whether they are marked reusable, meaning usable as a shared step sequence inside other flows. Choose All flows to see everything, or filter to only reusable or only non-reusable flows when auditing which flows exist purely as shared building blocks. | dropdown | No | All flows |
| Impacted only | When on, restricts the list to flows impacted by a recent change, such as to a reusable flow they depend on, so you can find and re-verify affected flows instead of checking every flow manually. Off shows the full unfiltered list. | toggle (Off / On) | No | Off |
Column reference
| Column | What it shows | How to read it |
|---|---|---|
| Name | The flow's display name. | The name is a link: selecting it opens the Run dialog to start a run against that flow. |
| Status | Shows whether the flow itself is enabled for use. | Active means the flow can be run or scheduled. No other status was observed in this list. |
| Source | Shows which imported API source the flow was built from or is linked to. | Match this value to an entry on API Testing: API Sources to find the underlying API definition. |
| Nodes | Shows how many request and action steps make up the flow. | A higher count means a longer step chain, for example login plus several requests and checks; use it to gauge a flow's complexity before editing it. |
| Last Run | Shows the outcome and timestamp of the most recent run of this flow. | A red Failed marker with a timestamp means the latest run did not finish successfully; check API Testing: Run History for the full result and other possible outcomes. |
| Tags | Shows labels assigned to the flow for organizing or filtering flows. | A dash means no tags are assigned to this flow yet. |
| Actions | Holds the per-row icon controls for editing, scheduling, exporting or duplicating, and deleting the flow. | Four icons are always shown for a flow; see Controls reference to identify each one. |
Controls reference
Import
Opens a dialog to bring in a flow definition from a shared library or an uploaded file instead of building one manually.
When to use: When you want to reuse a pre-built flow rather than creating it from scratch.
Side effects: Opening the dialog is read-only; confirming the import is mutating and adds a new flow to the list.
Generate with AI
Starts creating a new flow with its steps drafted automatically instead of added one by one.
When to use: When you want a starting draft to edit rather than building every step by hand.
Side effects: Opening the generation dialog is read-only; confirming the draft is mutating and adds a new flow. Availability depends on a platform-wide AI setting controlled by an administrator.
Blank
Creates a new flow immediately with no steps and opens it in the editor.
When to use: When you want full manual control over every step, starting from nothing.
Side effects: Mutating: a new empty flow is created right away and appears in the list.
Login & reuse token
Creates a new flow immediately, pre-filled with a login step, a step that captures the returned bearer token, and a protected request step that reuses that token, then opens it in the editor.
When to use: When the API you are testing requires authenticating once and reusing the token across later calls, so you don't have to wire up the token-capture logic yourself.
Side effects: Mutating: a new flow with these steps is created right away and appears in the list.
Create New
Creates a new API testing flow and opens it in the editor.
When to use: Your main entry point for adding a flow when none of the Import, Generate with AI, or Login & reuse token shortcuts fit.
Side effects: Mutating: a new flow is created right away and appears in the list.
Search (filter button)
Applies the current Search text, Source, Reusable, and Impacted only selections and reloads the table.
When to use: After changing any of the filter fields, to update the list to match.
Side effects: Read-only: reloads the list without changing any flow data.
Flow name link
Opens the Run dialog for that flow, where you choose an environment and start a run.
Side effects: Opening the dialog is read-only; confirming Start Run inside it is mutating and launches a new run.
Row action: settings (gear)
Opens the flow in the editor so you can change its steps, requests, or assertions.
When to use: To modify an existing flow's logic.
Side effects: Opening the editor is read-only; the flow is only changed once you save edits there.
Row action: schedule (calendar)
Opens API Testing: Schedules for that flow, to configure when it runs automatically.
When to use: To set up or review a recurring run instead of starting one manually.
Side effects: Read-only here; creating or changing a schedule happens on the Schedules page.
Row action: export/duplicate (document)
Exports the flow's definition, for backup or to move it elsewhere.
When to use: Before making risky changes to a flow, or to share it outside its current location.
Side effects: Read-only with respect to the original flow; produces an exported copy.
Row action: delete (trash)
Opens a confirmation before permanently removing the flow; the confirmation warns you if the flow is used by other flows or by profiles.
When to use: To remove a flow you no longer need.
Side effects: Mutating and destructive once confirmed: the flow is permanently removed, which can affect any flow or profile that references it.
Verify the result
After selecting Search, the table narrows to flows matching your filters, or shows no rows if nothing matches. Selecting a flow's Name link opens the Run dialog, and starting a run there updates that flow's Last Run column with a new outcome and timestamp once it completes. If the list doesn't narrow after Search, re-check the Search text and the Source and Reusable selections, since no matches returns an empty table rather than an error. If the Run dialog doesn't open, confirm you selected the flow's Name link in the Name column rather than one of the Actions icons.
Troubleshooting
- Symptom: Selecting Search returns no rows. Fix: Clear the Search text and reset Source to All Sources and Reusable to All flows to confirm the flow exists before narrowing again.
- Symptom: The Reusable filter is disabled. Fix: This happens when a flow's source doesn't report whether it is reusable; filter by Source or Search instead.
- Symptom: The table shows No Flows. Fix: Select Create New, Blank, Import, or Generate with AI to add your first flow, or check whether your filters are hiding existing ones.
- Symptom: The table shows Couldn't load the flows instead of your list. Fix: Select Retry; if it keeps failing, confirm you have permission to view API Testing flows.
- Symptom: The delete confirmation warns the flow is used by other flows or by profiles. Fix: Remove or update those references first, since deleting a flow still in use can break its dependents.
- Symptom: Row action icons are missing or disabled. Fix: This reflects your permission level; a read-only account can view the list but not edit, schedule, export, or delete flows.
Related articles
- Prerequisite: API Testing: API Sources - flows are built from or filtered by the API source imported there
- Prerequisite: API Testing: Environments - starting a run requires choosing an environment configured there
- See also: API Testing: Auth Profiles - manage authentication profiles a protected flow can use
- Next step: API Testing: Schedules - set up recurring runs for a flow from here
- Next step: API Testing: Run History - review the detailed outcome of runs launched from this page