---
title: "Setting Up Ask AI"
canonical: "https://help.agiloft.com/space/HELP/778960941/Setting+Up+Ask+AI"
format: markdown
---
Ask AI needs to be configured and enabled before it can be used. To do so, consult the sections below.

# Ask AI Setup 

To set up Ask AI, most users will have success by consulting the Ask AI Setup page in their KB.

1. Navigate to **Setup > Ask AI Platform**. Click Configure.
2. Check the Readiness meter at the bottom right of the page. This will indicate what steps you still need to take, as well as which steps you’ve completed. This walkthrough assumes you are at 0% to be comprehensive, though most users may already have some of the steps completed.
3. In the Licenses section, determine if you need one license or both. You can add both in one request. Remember to add an Email you have access to at the bottom of the form, as this is how you will access your license keys once requested.
  - If you need a Platform License only, click Request License and select Platform.
  - If you need a ConvoAI License only, click Request License, select Platform, and write “ConvoAI only” in the Comments section.
  - If you need both a Platform License and a ConvoAI License, click Request License, select Platform, and write “Both Platform and ConvoAI” in the Comments section.
4. After you submit your license request, you will receive an email with your License keys. In your KB, click the Install License button next to your required license, and paste the respective key value. Click Save. Repeat for additional licenses.
5. In the Global Variables section, click Install where it appears next to the each of the variables.
6. Under AWS Connection, click Connect. In order for this to work, all licenses and global variables must be installed.
7. Under Access Token API, click Deploy. This may take a few minutes.
8. Under OAuth2 Client Setup, click Deploy.
9. Ensure the Enable Ask AI toggle is set to On.
10. The AI Readiness status bar should now read 100%. Log out and log back in, and you should see the Ask AI button on your KB header.

## Ask AI Semantic Mappings

You can program your global search capability to recognize general terms, so users don’t have to always use exact terms from your database. For example, you can map "deal value" to the Contract Amount field.

You can create three layers of semantic mappings:

- **Business Term**: maps to field names, such as the Contract Amount example above
- **User Language**: maps to field values, such as Active in regards to contract Status
- **Terminology**: allows you to identify synonyms that act as redirectors in your search, as opposed to being mapped directly to parts of your system

To set up the search semantics:

1. Navigate to **Setup > Integration**.
2. Under Ask AI Semantic Mappings, click either Deploy or Configure.
3. Choose which mapping you’d like to set up from the tabs at the top of the page, and click New.
4. Add your term at the top of the page, and then fill out the remaining fields to map that term to your database, or align it with other terms.
5. Click Save.

# Alternative Methods

If you ran into any issues with the steps above, consider consulting the sections below. These sections show exactly where in your KB the required steps originally are located, and may help with troubleshooting.

## Check your licenses

To check if you have the proper licenses:

1. Navigate to **Setup > License > Manage Licenses**.
2. Ensure you have the following licenses:
  - AI Platform (Core): This is required to allow REST API requests
  - ConvoAI (Doc QA): This is required to activate Ask AI

If you don’t have one or either of these licenses, consult your Agiloft representative.

## **Check global variables**

To check if you have the proper global variable values:

1. Navigate to **Setup > System > Manage Global Variables**.
2. Under the Customized Variables section, check the following global variables. If any are not there, check the Variables with Default Values tab:
  1. Hot Link Server Root (hotlinkserverroot): In the Global Variable Value field, enter the first part of the KB's URL, beginning with `https://` and ending with `.com` or similar and then click Finish. An example is `https://example.agiloft.com`. Be careful NOT to include a backslash at the end of the URL. While this isn’t required to use Ask AI, it is required in order to generate URLs in the output.
  2. Feature Flags (feature_flags): If the KB contains the value `TT-2621` in the Global Variable Value field, remove it. Otherwise, do nothing.
3. Under the Variables with Default Values tab, check the following global variables for the proper Default Value:

| Variable | Logical Name | Expected Default Value |
| --- | --- | --- |
| Agiloft Services API endpoint version in request payload | `aws_agiloft_api_endpoint_request_version` | `v0` |
| Agiloft Services API Gateway Stage | `aws_agiloft_api_gw_stage` | `v0` |
| Agiloft Services API Gateway | `aws_agiloft_api_gw_url` | `https://agiloft-api-gw-{region}.agiloft.com` |
| Agiloft Services MCP Host API URL | `aws_agiloft_mcp_host_api_url` | `https://mcp-host-api-alb-{region}.agiloft.com` |

## Check AWS connection

Checking your connection to AWS follows a similar initial path to checking your region:

1. Navigate to Setup > Integration.
2. Under Agiloft Platform Services, click Configure.
3. Check that the AWS connection is enabled in your KB. Otherwise, add it using Connect.
4. Click Save.
5. Under Access Token API, check if it has been deployed by the presence of a Configure button. Otherwise, click Deploy. For information about Access Token APIs, visit  [https://agiloft-public.atlassian.net/wiki/pages/createpage.action?spaceKey=HELP&title=Scope%20Parameter](https://agiloft-public.atlassian.net/wiki/pages/createpage.action?spaceKey=HELP&title=Scope%20Parameter).
6. Click Save.
7. Under OAuth2 Client Setup, check if it has been deployed by the presence of a Configure button. Otherwise, click Deploy. For information about setting up OAuth2, visit [https://agiloft-public.atlassian.net/wiki/pages/createpage.action?spaceKey=HELP&title=Using%20OAuth2%20to%20Access%20REST%20API](https://agiloft-public.atlassian.net/wiki/pages/createpage.action?spaceKey=HELP&title=Using%20OAuth2%20to%20Access%20REST%20API).

## Check Group REST access

Ask AI requires that at least one group that a user is assigned to is included in Groups allowed for REST.

To check which Groups have REST access:

1. Navigate to Setup > System > Security.
2. Navigate to the Web Services tab.
3. Scroll down to REST Groups. All the highlighted Groups in this field have REST access. To add a new group, hold Command on a Mac or Control on a PC, and then make your selection. The default highlighted groups are as follows:
  - ACA and AI Add-on group
  - admin
  - Approver
  - Business Admin
  - Contract Admin
  - Contract Creator
  - Contract Manager
  - Contract Requester
  - Obligations Management

# Setting up eSignature

You can send a contract out for signature directly in AskAI with the eSignature agent. To set this up, you must complete the following:

1. Connect to an Adobe Sign account.
2. Once connected, you can begin working under normal circumstances. However, all contracts need to be manually prepared before sending by clicking Signatures > Create Adobe Sign agreement and saving the contract.

For more information about Adobe Sign, visit [https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/597295137](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/597295137). 

For more information about using the eSignature agent, visit [https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/779518250](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/779518250).

# Persistent Setup Issues

If you follow all of the steps in Ask AI Setup, have consulted the alternative methods, and still cannot access the feature successfully, consider checking the following sections:

## Refresh Checklist

Check the Refresh Checklist section of [https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43715391](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43715391). 

Don’t attempt this unless you can  already see the Ask AI header in your KB:

![image-20260717-171632.png](media://810e4ca6-1221-4c64-b4bf-f6f399ddfd3f)

You may need to follow the steps there, specifically the one about deleting the Agiloft MCP AI Client record. Navigate to Setup > Integration > OAuth2 Client Setup.

1. Delete the Agiloft MCP AI Client record.
2. Click Ask AI in the header (or from a table) to create a new Agiloft MCP AI Client record.