SmartBear AI in ReadyAPI

SmartBear AI provides AI-assisted capabilities in ReadyAPI to help generate, review, and optimize API tests using natural-language input.

Note

This beta release requires a license hosted in the SLM cloud environment. Support for on-premise SLM licensing is planned for upcoming releases and for general availability (GA).

Review the SmartBear Terms of Use for AI-Enabled Features before you turn on any AI functionality.

How AI works in ReadyAPI

SmartBear AI relies on foundational large language models (LLMs). SmartBear does not train any AI models on customer data.

Application-level control

ReadyAPI ships with SmartBear AI features disabled by default.

Enable or disable SmartBear AI in ReadyAPI

ReadyAPI ships with SmartBear AI features disabled by default.

Control SmartBear AI from the ReadyAPI UI

To enable the SmartBear AI features, follow these steps:

Open ReadyAPI.
In the toolbar, select Preferences.
In the left pane, go to Integrations, and select SmartBear AI.
Select Enable SmartBear AI integration.
Select OK.
After you enable SmartBear AI, the Open SmartBear AI button becomes active in the navigation bar. Use this button to open the Generate Tests with SmartBear AI dialog. When SmartBear AI is disabled, the button remains inactive.

Control SmartBear AI in managed deployments

Organizations that deploy ReadyAPI as a managed image can also control SmartBear AI availability with a JVM option. This setting disables AI features at startup and removes AI-related options from the ReadyAPI UI.

Use the following JVM option: -Dreadyapi.enable.ai.features=<value>
To turn off all AI features, set the value to: -Dreadyapi.enable.ai.features=false

SLM-level control

SmartBear License Management (SLM) controls access to SmartBear AI for your entire licensing organization. SLM enables AI by default, but your organization can disable it.

To disable SmartBear AI for all SLM users in your SLM organization, submit a SmartBear Support request with the following information:

Issue Type: Other
Request: Disable SmartBear AI for your SLM organization
Details: Include the exact SLM organization name

Disabling AI at the SLM level blocks all users in that organization from accessing AI features in ReadyAPI.

Using SmartBear AI in ReadyAPI

After enabling SmartBear AI, you can generate functional test cases directly from API definitions using natural-language prompts. SmartBear AI creates test steps and assertions based on your input and adds the generated test cases to the ReadyAPI Project Workspace.

For step-by-step instructions, examples, and screenshots, see Generate Tests with SmartBear AI [Beta].

Troubleshooting and feedback

During test generation, ReadyAPI may display validation or parsing messages related to the AI-generated response. These messages do not always prevent test creation but may require review.

For guidance on reviewing generated test cases, resolving validation errors, and submitting feedback or support cases, see Generate Tests with SmartBear AI [Beta].