Skip to main content

StudioAssist Preferences

Prerequisites
  • Katalon Studio Enterprise (KSE) 10.2.0.

You can configure to use StudioAssist to further improve your experience.

In Katalon Studio, go to Katalon Studio Enterprise > Settings > Katalon and select StudioAssist. Depending on your Account configuration, you will see a slight difference in the dialog.

AI service configuration

When AI services and Katalon AI are enabled for your Account, you can freely choose between using:

AI ProviderModel used (default)Configuration Details
Katalon AI Servicegpt-4.1-miniBuilt-in; no configuration needed.
Personal OpenAIgpt-4o-miniSelectable via KSE configuration window.
Azure OpenAIUser-specified deploymentRequires specifying the deployment name in configuration.
Geminigemini-2.5-flashURL points to the latest supported version of the Google Generative Language API.
OpenAI-Compatible Providergpt-4.1-miniAPI key passed via the Authorization HTTP header.
Choose between using Katalon AI Service, using your own OpenAI, Azure OpenAI API key, Gemini API key, or an OpenAI compatible provider.

Click on the tab below to find more information about the AI service.

When selected, there is no need to to set up a key for Katalon AI Service.

You can, however, configure StudioAssist to auto-tag AI-generated test cases (e.g., API test cases or code generation) with default or custom tags, include project context such as the Object Repository and Custom Keywords, and enable follow-up question suggestions in the chat for a more guided AI experience.

Choose between using Katalon AI Service or using your own OpenAI or Azure OpenAI API keys

StudioAssist Preferences options

Refer to the items below for the list and descriptions of StudioAssist Preferences options.

Append tags for test cases used AI generated capabilities

  • API Test Case Generation - Check this option to automatically tag AI-generated API test cases with a default tag (API_Test_Generation) or custom tag name of your choice. When enabled, StudioAssist adds an AI tag (default or custom) to each API test case it generates.

  • StudioAssist Code Generation - Check this option to automatically tag AI-generated test automation scripts from structured user prompts with a default tag (GenAI) or custom tag name of your choice.

Test cases with AI-generated tags are highlighted in purple.

Auto-include project context information

To improve the generated scripts from StudioAssist, you can enable the Object Repository information. This feature automatically uses the list of all test object IDs in that project as context.

This helps StudioAssist provide more tailored responses, while reduces the effort of having to provide the exact object paths or test objects you want to include in your test.

Auto-suggest follow up questions in the chat

When enabled, StudioAssist automatically suggests follow-up questions after providing a successful answer. This gives users greater control over their chat experience, whether they prefer guided suggestions or a more minimal interface.

Auto-suggest follow-up questions in the chat window

Customize engineering prompts with Prompt Library

Starting from version 10.2.3, you can customize your engineering prompts using Prompt Library to provide more context and improve the accuracy of StudioAssist responses.

  1. Click Katalon Studio Enterprise on the main navigation and select Settings to open the Preferences dialog.
  2. Select Katalon > StudioAssist > Prompt Library.
  3. Configure your Prompt Library. Click on the prompt type you want to customize. Edit this text directly to include more context or specific instructions about how you want the AI to respond.
StudioAssist Prompt Library
  • Chat instruction: Used in the StudioAssist chat window. This controls how StudioAssist responds to your general questions or guidance requests. Add more context about your application under test (AUT) or focus area, so you don’t have to repeat this every time you chat.
  • Generate code: Used in the script editor, add style guide details or coding preferences to make the generated code better fit your project.
  • Explain code: Used in the script editor, specify if you want detailed technical explanations or a high-level summary, depending on your needs.
Notes
  • Use ${userSelection} for Generate code and Explain code. This variable represents the specific piece of text or code you have highlighted (selected) in the script editor.
  • Customize prompt is not applied for Katalon AI service.
  1. Click Apply or Apply and Close to save.

You can now use StudioAssist with your customized prompts.

If the generated output is not to your expectation, simply open the Prompt Library and select Revert Original to revert each prompt or click Restore to Defaults to restore all prompts.

Was this page helpful?