From 5e4002494ac1091db72f095d09a382ae8499f784 Mon Sep 17 00:00:00 2001 From: "claude[bot]" <41898282+claude[bot]@users.noreply.github.com> Date: Wed, 22 Jul 2026 08:34:39 +0000 Subject: [PATCH] Fix: Improve clarity of Step 3 configuration in API Chat documentation - Add note about administrator access requirement - Explain what refers to with examples - Break down configuration into clear numbered steps - Add detailed restart instructions for Linux and Windows - Address user confusion about where to configure API Manager --- .../test-apis-with-apichat.md | 22 +++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/en/docs/consume/invoke-apis/invoke-apis-using-tools/test-apis-with-apichat.md b/en/docs/consume/invoke-apis/invoke-apis-using-tools/test-apis-with-apichat.md index 0dbfbb634a..9bd7fd81d4 100644 --- a/en/docs/consume/invoke-apis/invoke-apis-using-tools/test-apis-with-apichat.md +++ b/en/docs/consume/invoke-apis/invoke-apis-using-tools/test-apis-with-apichat.md @@ -39,7 +39,18 @@ Follow the instructions below to register your on-premise environment: ## Step 3 - Configure API Manager -1. The following configuration change must be done in the `/repository/conf/deployment.toml` file. Update the `[apim.ai]` config by providing the on-premise token obtained from Step 2. Also, be sure to update the endpoint field as below. +!!! note + This step requires administrator access to the API Manager server. If you don't have access to the server files, contact your system administrator to complete this configuration. + +To enable API Chat functionality, configure the API Manager server by following the steps below: + +1. Locate the API Manager installation directory on your server. + + The installation directory is referred to as ``. This is the root folder where you installed WSO2 API Manager (for example, `/usr/lib/wso2/wso2am-4.3.0` on Linux or `C:\Program Files\WSO2\API Manager\4.3.0` on Windows). + +2. Open the configuration file located at `/repository/conf/deployment.toml` using a text editor. + +3. Add or update the `[apim.ai]` configuration section with the on-premise token you generated in Step 2. ```toml [apim.ai] @@ -47,8 +58,15 @@ Follow the instructions below to register your on-premise environment: endpoint = "https://dev-tools.wso2.com/apim-ai-service" token = "" ``` + + Replace `` with the actual token you copied from Choreo in Step 2. -2. Restart the API Manager. +4. Save the configuration file. + +5. Restart the API Manager server for the changes to take effect. + + - On Linux: Run the shutdown script `/bin/api-manager.sh stop` and then start the server using `/bin/api-manager.sh start` + - On Windows: Stop the Windows service or close the command window running the server, then restart using `\bin\api-manager.bat` ## Step 4 - Test your APIs