Enabling real-time data retrieval through a Web API connection

An administrator configures the Web API connection and maps it to the Web Search (Web API Definition) to enable secure access to external data sources. With this setup, the AI agent retrieves real-time, relevant information from connected systems in response to a query.

Task 1: To create a Web API connection

1. Select Innovation Studio > Administration > Integrations > Web APIs > Web API connections.
2. To create a new Web API connection, click +New.
   
    
3. On the General Authentication tab of New Web API connection dialog box, enter the following details and click Next:

   Field name	Value
   Name (Required)	Google API
   Host name (Required)	www.googleapis.com
   Port (Required)	443
   Protocol (Required)	HTTPS
   Authentication (Required)	Custom

4. Click Add query parameters.
   • Update the following mandatory fields:

     Key	Google API key
     cx	The programmable Search Engine ID. To obtain the cx ID, you must create a new search engine on the Programmable Search Engine Console.

   • (Optional) Update the following fields to restrict search results from a specific domain:

     siteSearch	A comma-separated list of websites that you want to include or exclude from the search.
     siteSearchFilter	Indicate whether to include or exclude the website added in the siteSearch parameter. Valid values: e: Exclude i: Include

      

5. Click Save.

Task 2: To create a connection process

1. Open HelixGPT Agents Studio and click the Processes tab.
2. Select Web Search and click Copy.
   Copy definition dialog box, as shown in the following screenshot, is displayed:
3. Create a copy of the process and open the copied process.
4. Select the Google Search Request element as shown in the following screenshot:
   
5. Expand Input Map.
6. From the Connection drop-down list, select the new API connection you have added.
7. Save the process.

Task 3: To map the Web API connection

1. Select Innovation Studio > Administration > Integrations > Web APIs > Web API mapping.
2. From the Application drop-down list, select HelixGPT Agent Studio.
3. From the Connection Configuration drop-down list, select a connection.
   A message is displayed as shown in the following screenshot: