Katalon AI Assistant Preferences

This guide shows you how to set up AI services in Katalon AI Assistant, use AI to generate test cases, add project context automatically, get follow-up question suggestions in the Katalon AI Assistant chat window, and customize prompts in the Prompt Library.

Requirements

• AI services and Katalon AI are enabled for your Account, see Configure AI Services.

You can configure to use Katalon AI Assistant to further improve your experience.

In Katalon Studio, go to Katalon Studio Enterprise > Preferences > AI configurations and select a model.

If your account has no configured AI model, the following notification appears: There is no AI model in your account. You can then click Request Access to contact your account owner to enable AI features, or add your own API key.

For OpenAI compatibility information, refer to OpenAI Supported Models.

AI service configuration

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

AI Provider	Supported model	Notes
Katalon AI Service	Agent mode: gpt-5.2 Ask mode: gpt-5-mini	Built-in; no configuration needed. Supports multilingual inputs.
Personal OpenAI	gpt-5.4 gpt-5.2 gpt-5.1 gpt-5 gpt-5-mini gpt-4.1 gpt-4.1-mini gpt-4o-mini o1 o3-mini gpt-4o gpt-3.5-turbo	Supports multilingual inputs.
Azure OpenAI	User-specified deployment Tested with: API version: 2025-01-01-preview Deployment ID: o3-mini	Requires specifying the deployment name in configuration. Notes: Some older API versions do not support tool calls in Agent mode.
Gemini	gemini-3.1-pro gemini-2.5-pro gemini-2.5-flash	URL points to the latest supported version of the Google Generative Language API.
OpenAI-Compatible Provider	Tested with gpt-4.1-mini	API key passed via the Authorization HTTP header.
AWS Bedrock	Claude Haiku 4.5 Claude Sonnet 4.5 US Claude Opus 4.1 US Claude Sonnet 4	Requires credential-based authentication configuration.

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

Katalon AI

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

You can, however, configure Katalon AI Assistant 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.

Preset AI Service

If your Admin has enabled the use of the organization’s AI key, the AI provider is shown at the top of the dialog as: "AI provider name – managed by your organization".

With this setting, you can configure the token limit and model for the AI service. You cannot switch between services (Katalon AI, OpenAI, Azure, Gemini, or OpenAI compatible provider).

Personal AI keys

In the case of AI features are disabled, you can opt for your personal OpenAI key, Azure OpenAI API key, Gemini API key, Open-AI compatible provider, or AWS Bedrock key.

• Provide service provider configuration.

  • Use personal OpenAI key: Provide the following information before using:

    • Secret key: To get your Secret key, refer to the provider's instruction: Where do I find my secret key?.
    • Max completion token: The default value that sets the maximum number of tokens the model can return in its response. The default value is 16000. To learn more about the token limits, refer to the OpenAI rate limits documentation: OpenAI Token Limits.
    • Organization ID (optional): The organization ID on OpenAI is the unique identifier for your organization which can be used in API requests.
    • Model: The OpenAI model you want to use. If not changed, the gpt-4o-mini model is used by default.

  • Use personal Azure OpenAI API key: Provide the following information before using:

    • Base URL: The base URL for your Azure OpenAI resource in the following format: https://{your-resource-name}.openai.azure.com.
    • Deployment name: Azure OpenAI uses the deployment name to call the model. Enter the deployment name of your choosing, make sure that the model supports chat completion.
    • API key: To get your Azure OpenAI key, refer to this article: How to get Azure OpenAI Keys and Endpoint
    • Max completion token: The default value that sets the maximum number of tokens the model can return in its response. The default value is 16000.
    • API version: API version is selected for you by default.

  • Use Gemini API key: Provide the following information before using:

    • Base URL: The base URL used to connect to the Gemini API service. This URL should point to the correct version of the Google Generative Language API.
    • API key: Your Gemini key. Create a key for free in Google AI Studio.
    • Model: The Gemini model you want to use. If not, Katalon AI Assistant will use the latest supported version of the Google Generative Language API by default.
    • Max completion token: The default value that sets the maximum number of tokens the model can return in its response.

  • Use Open-AI compatible provider: Provide the following information before using:

    • Base URL: The API endpoint for your OpenAI-compatible service.
    • API key: Your API key.
    • API key header name: The name of the HTTP header where the API key is passed (commonly Authorization). This allows support for providers with different header naming conventions.
    • Model: The model you want to use. If not changed, the gpt-4.1-mini model is used by default.
    • Max completion token: The default value that sets the maximum number of tokens the model can return in its response.

  • Use personal AWS Bedrock key: Provide the following information before using:

    • AWS access key: Your AWS access key ID. To learn how to create one, see Managing access keys for IAM users.
    • AWS secret key: The secret key paired with your access key ID for authentication. You can only view it once when creating the key pair.
    • AWS session token: A temporary security credential provided by AWS Security Token Service (STS). Required only if you use temporary credentials, such as those from assuming an IAM role or MFA authentication. For details, see GetSessionToken.
    • AWS region: The AWS region where your Bedrock model is available.
    • Model: The model ID in your AWS Bedrock account. See Supported foundation models in Amazon Bedrock.
    • Max completion token: Sets the maximum number of tokens the model can return in its response. The default value is 16000.
    note

    Katalon Studio currently does not support proxy connections for AWS Bedrock.

  • Disable Katalon AI Assistant: If you don't want to use any AI provider, you can disable Katalon AI Assistant by selecting None from the AI service provider list. When disabled, the chat window will display that no AI is available in your account.

Katalon AI Assistant Preferences options

Refer to the items below for the list and descriptions of Katalon AI Assistant Preferences options.

Append tags for test cases used AI generated capabilities

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

• 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, Katalon AI Assistant adds an AI tag (default or custom) to each API test case it generates. For details, see Generate API tests.

• Katalon AI Assistant 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. This option will automatically add the tag for these two actions:

  • Generate code via Script View: When you use Katalon AI Assistant to generate code directly within the Script mode of an existing test case. See Generate code.

  • Create and edit test cases via Katalon MCP Server: When you use Agent mode to perform actions like creating a new test case or editing an existing one based on your prompts. Learn more in Katalon AI Assistant Agent mode.

Auto-include project context information

To improve the scripts generated by Katalon AI Assistant, you can enable both the Object repository and your Custom keywords. Katalon AI Assistant will then automatically use the list of all test object IDs and available custom keywords in the project as context. This feature applies only to Ask mode, because Agent mode can already connect to MCP servers and utilize their tools to access project context or create custom keywords. Learn more about Katalon AI Assistant's Katalon built-in MCP tools.

Enabling this option helps Katalon AI Assistant deliver more tailored responses, reduces the need to specify exact object paths or test objects, and lets you reuse predefined actions through custom keywords directly in the generated scripts.

Auto-suggest follow up questions in the chat

When enabled, Katalon AI Assistant 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.The feature works only for Ask mode.

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 Katalon AI Assistant responses. This works for both Ask mode and Agent mode.

1. Click Katalon Studio Enterprise on the main navigation and select Settings to open the Preferences dialog.
2. Select Katalon > Katalon AI Assistant > 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.

• Ask mode: Used in the Katalon AI Assistant Ask mode. This controls how Katalon AI Assistant 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.
• Agent mode: This defines the behavior of Agent mode in the Katalon AI Assistant chat window. . This defines the agent’s behavior, tool priorities, and response patterns. You can customize this prompt to match your workflow, team conventions, or testing methods, for example, setting tool priority. Changes take effect right away and are saved across restarts. You can click Revert Original or leave the prompt empty to use the default prompt from Katalon AI Assistant system.
• 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.
• Analyze test failure: Used to customize the system prompt for AI Failure Analysis. This defines how Katalon AI Assistant interprets failure logs and generates analysis results.

4. Click Apply or Apply and Close to save.

You can now use Katalon AI Assistant 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.

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.