Skip to content

Fix: Improve clarity of Step 3 configuration in API Chat documentation [4.3.0] #11690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wso2-engineering-bot wants to merge 1 commit into
base: 4.3.0
Choose a base branch
from
Open

Fix: Improve clarity of Step 3 configuration in API Chat documentation [4.3.0] #11690

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions en/docs/consume/invoke-apis/invoke-apis-using-tools/test-apis-with-apichat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,34 @@ 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 `<API-M_HOME>/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 `<API-M_HOME>`. 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 `<API-M_HOME>/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]
enable = true
endpoint = "https://dev-tools.wso2.com/apim-ai-service"
token = "<use token that you generated>"
```

Replace `<use token that you generated>` 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 `<API-M_HOME>/bin/api-manager.sh stop` and then start the server using `<API-M_HOME>/bin/api-manager.sh start`
- On Windows: Stop the Windows service or close the command window running the server, then restart using `<API-M_HOME>\bin\api-manager.bat`

## Step 4 - Test your APIs

Expand Down