Create and manage API testing flows

Updated

Create and manage API testing flows

Mode: the create and edit controls described on this page are shown in Expert mode (sidebar footer toggle Mode: Basic / Expert). In Basic mode the page shows only Refresh.

Overview

Use API Testing Flows to view existing API flows, create a flow manually, generate a flow with AI, and review flow run history.

Before you begin

  • API Testing module is licensed.
  • Have an API source or OpenAPI/Swagger specification available if you want to create a flow. See the task guide "Manage API sources and environments".
  • Configure an AI provider before using Generate with AI. AI providers are configured on Operations: Settings under the AI Providers tab (Settings > AI Providers: Add Provider, then a table of Name, Provider, Model, API Key, Capabilities, Validated and Default).

Steps

Step 1

Open API Testing > Flows. Use Search, Source, and Impacted only to filter flows. If no flows exist, the page shows No Flows and offers Create New Flow. Create and manage API testing flows - step 1 Create and manage API testing flows - step 1 detail

Step 2

Click Create New or Create New Flow. On Details, enter Flow Name, add an optional Description and Tags, then click Next to continue through Source, Operations, Config, and Review. Create and manage API testing flows - step 2 Create and manage API testing flows - step 2 detail

Step 3

Click Generate with AI. Select an AI Provider. If the page shows No AI provider configured, configure one on Operations: Settings (tab AI Providers) before continuing to API Source, Describe Flow, Preview, and Save. Create and manage API testing flows - step 3 Create and manage API testing flows - step 3 detail

Step 4

Open API Testing > Run History. Use the Flow and State filters, then click Search. Use Back to Flows or Go to Flows to return to the flow list. Create and manage API testing flows - step 4 Create and manage API testing flows - step 4 detail

Verify the result

The flow list opens, the manual and AI flow wizards are accessible, and Run History shows filters for Flow and State. If no runs exist, the page shows No Runs.

Troubleshooting

  • If Next is unavailable in the manual wizard, enter a Flow Name and complete the required fields on the current step.
  • If AI generation cannot continue, configure an AI provider on Operations: Settings, tab AI Providers.
  • If the run list is empty, run an API flow first, then return to Run History.
  • If expected flows or runs are not visible, clear the Search field and set Source, Flow, and State filters back to All.
Was this article helpful?
0 out of 0 found this helpful