Katalon AI Assistant Overview
Katalon AI Assistant is Katalon Studio's built-in AI assistant that helps you design, generate, and maintain automated tests. It supports workflows ranging from quick natural-language Q&A to fully guided, project-aware automation powered by Model Context Protocol (MCP) servers.
- Katalon Studio Enterprise (KSE) license β required to use the built-in Katalon AI Service without your own API key.
- Or a personal API key from a supported provider (OpenAI, Azure OpenAI, Google Gemini, AWS Bedrock, or an OpenAI-compatible service). Configure this in Katalon AI Assistant Preferences.
Modesβ
You can switch between two modes in the Katalon AI Assistant chat window:
- Ask mode: Conversational chat for questions, code snippets, and explanations. Supports multiple locally saved conversations. See Katalon AI Assistant Ask mode.
- Agent mode (default): Executes multi-step, project-aware actions via MCP servers and tailored agent profiles. Conversations are scoped to the mode and Agent Profile they were created with. See Katalon AI Assistant Agent mode.
Open chat windowβ
The Katalon AI Assistant chat window opens automatically on the right panel when Katalon Studio starts. Alternatively, click the Katalon AI Assistant icon in the main toolbar to open it, or use Ctrl + Shift + N (Windows) and ^ + β₯ + N (macOS).
Manage conversationsβ
Conversations are saved locally on your machine and remain available after you close the chat window or restart Katalon Studio.
- Click New chat to start a separate conversation without losing the current one.
- Click All chats to view previous conversations and switch between them.
- Hover over a conversation in All chats, then click the more options menu to Rename or Delete it.
- New conversations use New chat as the temporary title. After you send the first message, Katalon AI Assistant automatically generates a short title that summarizes the conversation.
- Conversations are tied to the mode and agent profile they were created with. Reopening a conversation automatically switches back to that mode and agent profile.
Conversations are stored at the application level for the current local user, not in the project folder. The conversation list is filtered by your current project and enabled Agent Profiles.
All chats shows conversations based on project context and enabled Agent Profiles. If no project is open, Ask mode and generic-agent conversations appear. If a project is open, conversations from Agent Profiles enabled in that project also appear. If an Agent Profile is disabled or deleted, conversations associated with it do not appear in All chats while that profile is unavailable.
For long conversations, Katalon AI Assistant automatically summarizes earlier messages when a conversation gets long. This helps keep both Ask mode and Agent mode conversations within the active model's context limit without requiring you to manually clear the chat.
If summarization fails, no messages are removed. You can continue chatting, but starting a new chat might produce better results for a different task or context.
Use current file as contextβ
Available in both Ask mode and Agent mode.
Katalon AI Assistant automatically includes the content of the file you are actively editing as context, so you do not need to copy-paste file content into the chat.
The Current file box is selected by default in the chat window. When you switch between files, the context updates automatically. To turn this off, untick the box. Current file context is scoped to the active conversation and follows the mode and agent profile tied to that conversation.
- Test case
- Test suite
- Dynamic test suite
- Test listener
- Web service request
- Custom keyword
- BDD feature file
- Profile
- Step definition (
.groovyfile) - Java class (
.javafile)
AI capabilitiesβ
| 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β
| Service Type | Requirement | Setup |
|---|---|---|
| Katalon AI Service | KSE License | None β enabled automatically. |
| Personal API Key | KSE License, user-provided key from a supported provider | Configure in Katalon AI Assistant Preferences. |
Supported external providers: OpenAI, Azure OpenAI, Google Gemini, OpenAI-compatible providers, and AWS Bedrock.
To select your preferred provider and model, see: AI service configuration.
Supported AI modelsβ
| AI Provider | Supported Models | Notes |
|---|---|---|
| Katalon AI Service | gpt-5.4 | No configuration needed. Supports multilingual inputs. |
| Personal OpenAI | gpt-5.5, 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 | Selectable in the KSE configuration window. English only. |
| Azure OpenAI | User-specified deployment. Tested with: API version 2025-01-01-preview, Deployment ID o3-mini. | Requires specifying the deployment name. English only. Older API versions may not support tool calls in Agent mode. |
| Gemini | gemini-3.5-flash, gemini-2.5-pro, gemini-2.5-flash | Points to the latest supported Google Generative Language API version. |
| OpenAI-Compatible Provider | gpt-4.1-mini | API key passed via the Authorization HTTP header. |
| AWS Bedrock | US Claude Opus 4.1, US Anthropic Claude 3.7 Sonnet, US Anthropic Claude Sonnet 4.5, US Anthropic Claude Haiku 4.5, US Claude Sonnet 4, anthropic.claude-3-5-sonnet-20241022-v2:0 | Requires credential-based authentication configuration. |
Common use casesβ
- Ask mode use cases β Q&A, code snippets, test concept explanations.
- Agent mode use cases β Automated test creation, editing, and project-aware actions.
Known limitationsβ
- AI hallucinations: Katalon AI Assistant may generate code with non-existent built-in keywords. Always review and validate generated code before running it.
- Debugging expertise required: Generated code may need programming knowledge to debug, especially for complex test scenarios.
- Language support: Ask mode with a personal API key (OpenAI, Azure OpenAI) supports English only. The built-in Katalon AI Service supports multilingual inputs.
FAQsβ
Do I need my own API key to use Katalon AI Assistant?β
No. With a KSE license, Katalon AI Assistant uses the built-in Katalon AI Service without requiring your own API key. To use a different provider, configure a personal API key in Katalon AI Assistant Preferences.
Can I use keyboard shortcuts with Katalon AI Assistant?β
Yes. Highlight code or a comment in the script editor, then use:
macOS:
- Generate code:
^+β₯+C - Explain code:
^+β₯+E
Windows:
- Generate code:
Ctrl+Alt+C - Explain code:
Ctrl+Alt+E
What should I do when generated test scripts fail to run?β
Generated scripts may fail when test objects, variables, or action steps are missing or undefined. Before generating code, prepare your project:
- Capture the test objects in the Object Repository.
- Define all variables the script will reference.
- List each action step with its corresponding test object and variable.
Why is Agent mode not calling any MCP tools?β
You may be using a legacy API version. Update to a newer API version for your provider. See: AI service configuration.
Why is Katalon AI Assistant not working?β
Use the table below to identify and resolve common issues:
| Symptom | Likely Cause | Resolution |
|---|---|---|
| Warning when enabling AI features | AI features disabled at the Account level | Contact the Account Owner to enable AI features. |
| AI assistant unavailable | Not on a KSE license | Upgrade your license. |
| AI assistant unavailable | Logged in via a License Server | Not supported. Log in via cloud authentication instead. |
| AI not working | Proxy misconfiguration | Update to version 9.4.0 or later. |
Error: Session not active or invalid_grant | Logged in on multiple devices simultaneously | Log out from all devices, then log in again. |
Error code {"code":8} (Katalon AI Service) | Input too large or usage limit reached | Clear the current conversation, disable Auto-include project context information, or split your prompt into smaller parts. |