Application sources

You can add, edit, or refresh application sources to store them in a vector database as embeddings so that the API Agent can search for APIs.

Before you begin

Ensure that you have administrator and API Agent user permissions to view the API Agent tab and access the API Agent sources page. For more information, see .

About this task

By configuring application sources, you can keep your API development environment up to date, automate refresh schedules, and maintain accurate object lists for API generation and design workflows.

You can do the following actions to configure the list of application sources under each application objects:

Adding an application source
Editing object list
Manual refresh
Auto refresh
Editing connection
Removing application sources

Procedure

To add a application sources, you need to provide the necessary connection information for the application, including a name, location, and credentials. After you provide the connection information, the system add an application source to make available for use in your APIs. To add an application source, complete the following steps:
1. In API Manager, click Settings > API Agent.
2. On the Application tab, click Add.
  
  Note: API Agent now supports usage of multiple applications.
3. On the Application connection page, select the required application and enter the necessary details, and then click Next.
4. On the Application objects page, select the objects, and then click Next.
  
  Note: To ensure that you can add application sources successfully, avoid selecting a large number of objects.
5. Optional: To create auto refresh settings, set Auto Refresh to On.
6. Select the required auto refresh frequency and click Add.
To modify the object list, complete the following steps:
1. In API Manager, click Settings > API Agent.
2. In the Application sources section, click the Overflow menu, and then click Edit object list.
3. On the Edit objects page, select the checkbox to add or remove the object, and then click Save.
To reflect any changes that were made in the backend, the Refresh option updates the application source. For example, if you added or deleted any fields in the object list, refresh the object to show the most recent updates. To refresh the application, click the Overflow menu and click Refresh.
To auto refresh, complete the following steps: click the Overflow menu and click Auto refresh settings.
1. Click the Overflow menu and click Auto refresh settings.
2. In the schedule refresh dialog box, set Auto Refresh to On.
3. Select the refresh frequency, and then click Save.
To edit the fields in the Application connection window, use the Edit connection option and complete the following steps:
1. In the Application sources section, click the Overflow menu, and then click Edit connection.
2. On the Application connection page, update the connection details as necessary.
3. Click Next.
When you remove an application source, you remove it from the API Manager UI and from the backend, which means that the data is inaccessible. To remove an application source, complete the following steps:
1. In API Manager, click Settings > API Agent.
2. In the Application sources section, click the Overflow menu and then click Remove.