Katalon AI Assistant Overview
This guide provides an overview of Katalon AI Assistant’s AI capabilities, the AI providers and models it supports, access and licensing requirements, and related use case resources that help you explore how AI can support your testing workflows.
Starting 10.3.2 you can switch between Agent mode and Ask mode in Katalon AI Assistant chat window:
- Ask mode (default): Get quick answers, explanations, and code snippets.
- Agent mode: Automate test creation and editing with Katalon best practices and integrated tools. See Katalon AI Assistant Agent mode to learn more.
Overview
Katalon AI Assistant is Katalon Studio’s built-in AI assistant that helps you design, generate, and maintain automated tests more efficiently. It supports a range of AI workflows, from quick natural-language questions to fully guided, project-aware automation powered by Model Context Protocol (MCP) servers.
AI capabilities in Katalon Studio
| Capability | Description | Benefit |
|---|---|---|
| Ask Mode | Conversational chat for questions about Katalon Studio, keywords, or testing concepts. See: Katalon AI Assistant Ask mode. | Instant guidance and knowledge retrieval. |
| Agent Mode | Executes multi-step, project-aware actions through MCP servers. See: Katalon AI Assistant Agent mode.
| Automated creation and modification of project artifacts. |
| Inline Code Generation & Explanation | Generates code from commented prompts and explains selected snippets directly in the Script mode. See: Generate and Explain code in script editor. | Faster scripting and easier debugging. |
| AI Failure Troubleshoot | Analyzes and troubleshoots failed test cases/test suites. See AI Failure Troubleshoot | Resolve failed test cases without manual code editing. |
| AI Failure Analysis in Reports | Analyzes failed test cases in HTML and email reports - reads stack traces, identifies root causes, and explains failures in simple language. See: AI Failure Analysis in Reports. | Faster issue diagnosis and reduced debugging time. |
| Customize Engineering Prompts | Customizes system prompts for Ask Mode, Agent Mode, code generation, explanation, and failure analysis via the Prompt Library. See: Customize engineering prompts with Prompt Library. | More accurate and context-aware AI output. |
| AI-Generated API Tests | Generates editable API test cases and test objects from OpenAPI specifications. See: Generate API tests with Katalon Studio’s AI. | Builds API testing workflows more quickly. |
Access and licensing
Katalon AI Assistant supports both built-in and external AI providers.
| Service Type | Key Requirement | Setup Required? |
|---|---|---|
| Katalon AI Service | KSE License | No – enabled automatically. |
| Personal API Key | User-provided key | Yes – configure in Katalon AI Assistant Preferences. |
Katalon AI Assistant integrates with several external providers, including OpenAI, Azure OpenAI, Google Gemini, OpenAI-compatible providers, and AWS Bedrock.
You can select your preferred provider and model within the Katalon AI Assistant preferences. For configuration details, see: AI service configuration.
Supported AI models
Refer to the table below to see which AI models Katalon AI Assistant supports when using different AI providers.
| AI Provider | Model used | Notes |
|---|---|---|
| Katalon AI Service | gpt-5-mini | Built-in; no configuration needed. Supports multilingual inputs. |
| Personal OpenAI |
| Selectable via the KSE configuration window. Note: Currently supports English only. |
| Azure OpenAI | User-specified deployment Tested with:
| Requires specifying the deployment name in configuration. Notes:
|
| Gemini |
| URL points to the latest supported version of the Google Generative Language API. |
| OpenAI-Compatible Provider |
| API key passed via the Authorization HTTP header. |
| AWS Bedrock |
| Requires credential-based authentication configuration. |
Common use cases
To explore what Katalon AI Assistant can help you accomplish, see:
Known limitations
As of Katalon Studio version 10.3.0, Katalon AI Assistant now includes fewer limitations compared to previous versions, thanks to ongoing improvements in AI capabilities and context handling. However, some constraints still apply:
- Potential AI hallucinations: Katalon AI Assistant may generate code with made-up built-in keywords. Always review and validate the generated code, and revise with the valid equivalent when applicable.
- Programming language required: Due to context limitations, generated code might require debugging and programming expertise.
Katalon AI Assistant FAQs
Can I use Katalon AI Assistant without inputting my own OpenAI key?
When first introduced in 9.0.0, Katalon AI Assistant required you to input your own OpenAI API key. With the change in 9.4.0, you can use Katalon AI Assistant with a KSE license directly without having to input your own key.
Can I use hotkeys for easy access to Katalon AI Assistant?
You can highlight a piece of code or comment on the script editor and use these shortcuts for Katalon AI Assistant quicker:
On macOS:
- Generate code:
^+⌥+C - Explain code:
^+⌥+E
On Windows:
- Generate code:
Ctrl+Alt+C - Explain code:
Ctrl+Alt+E
What should I do when the generated test scripts do not run?
If you are using Katalon AI Assistant to generate a script in a test case, make sure that you capture the test object in the Object Repository, define the variables, and list out the actions in steps with corresponding test objects and variables.
Why is Agent Mode not using any MCP tool in responses?
It's likely that you are using a legacy API version. Try using a newer API version of your provider.
Why is Katalon AI Assistant not working for me?
Possible reasons include:
- AI features are disabled at the Account level. You might see a warning message when trying to use Katalon AI Assistant in this case. Contact the Account Owner to turn AI features so you can use Katalon AI Assistant again.
- You are not on an Enterprise license (required since version 9.4.0). Upgrade your license to continue using Katalon AI Assistant.
- You are logging in via a License Server (not supported).
- Proxy issues (update to version 9.4.0+).
- If you encounter this error message:
The OpenAI secret key is missing. Please provide your key and try again.,you may need to:- Input your own OpenAI key if you are using Studio in version prior to 9.4.0.
- Upgrade to 9.4.0 onwards and make sure you have a KSE license.
- If you encounter this error message:
{"error":"invalid _grant", "error _description": "Session not active"}, you may have logged in using more than one machine at the same time. Log out from all devices and log in again. - If you encounter this error message in the Katalon AI Assistant Chat window with the Katalon AI Service:
com.kms.katalon.ai.core.model.exception.Katalon AI AssistantLlmApiClientException: {“code”:8}, it is usually caused by a large input size or hitting the current usage limits. To resolve this issue, try the following recommendations:- Clear the current conversation.
- Disable Auto-include project context information.
- Split your question into smaller parts.