Getting started

To install API Agent, download and install the Visual Studio Code plug-in. Then, you can log in to API Agent in Visual Studio Code using the URL for API Connect.

• Install the API Agent plug-in in Visual Studio Code to automate tasks with natural language prompts. This setup helps you streamline API development by generating specs, tests, and code directly from API Agent. To install API Agent in Visual Studio Code, complete the following steps:
  1. Log in to API Manager
     Note: The <environment short id> value varies. Copy the value from the browser URL when you are logged in to your IBM® webMethods Hybrid Integration account.
  2. On the API Manager home page, click Tools for download in the More section.
  3. In the Tools for download window, click the API Agent tab.
  4. Click Download next to the Step 1: Download Visual Studio Code plug-in for API Agent.
     Note: Downloading the .vsix file might take a few minutes.
  5. Open Visual Studio Code.
  6. In the left panel, open Extensions.
  7. Click the Views and More Actions icon (...), and select Install from VSIX.
  8. Open the folder where you downloaded the plug-in, and select the api-agent-vscode-plugin-0.0.1-<build_number>.vsix file, and then click Install. You can view the API Agent icon on the left panel.
  9. To upgrade the API Agent plug-in, repeat steps 1-8 and install the recent .vsix file.
     Note: Ensure that the .vsix file is the recent version.
• Log in to API Agent in Visual Studio Code to begin prompt-based automation for API development. To log in to API Agent, complete the following steps:
  1. Open Visual Studio Code.
  2. Click the API Agent icon.
  3. In the Host URL field, enter the API Manager URL and then click Log in.
     Note: The Host URL is the fully qualified hostname or IP address. Contact your administrator for the appropriate URL.
  4. Click Allow to sign in and then select Open when prompted.
  5. On the browser, if you are not automatically redirected, select use this link and then in the Visual Studio Code, click Open.
  6. Select a Provider organization, and click Continue.
  7. To start a new chat session or to logout, click the IBM API Agent menu and select one of the following options:

     New chat

     Starts a new chat session. In this public preview, previous chat sessions are not accessible. For more details, see Limitations.

     Logout

     Logout from API Agent.

  8. To view the host URL and organization information, in the upper-right corner of the window, select your organization.
     For example,