Create an API with the Jitterbit API Manager AI Assistant
Introduction
The APIM AI Assistant is an AI chatbot that helps you create and maintain assets in API Manager by interacting with it using written natural language. The following interactions are supported:
- Custom APIs: Create, publish, edit, clone, and delete.
- Security profiles: Create and edit.
- Trusted IP groups: Add and edit.
- API groups: Add and assign APIs.
Access the assistant from these places:
- In the Harmony portal header on any API Manager or Integration Studio page using the Jitterbit AI icon. In the chatbot panel, use the dropdown to select APIM Assistant.
- In Integration Studio using the operation actions menu to select Publish as an API using AI.
Important
The APIM AI Assistant is hidden unless your Harmony license includes the APIM AI Assistant option. Contact your Customer Success Manager (CSM) to have it added to your Harmony license.
Recommendations
You should interact with the APIM AI Assistant as you would with any large language model (LLM) AI product.
The following suggestions are recommended:
-
Write in English using whatever wording comes naturally to you, as if talking to a person with your own level of IT and business knowledge. Other languages may be used but have not been validated.
-
To get ideas of what interactions you can perform, ask the assistant in natural language what it can do, or type
help
. -
Read the prompts carefully before typing your reply. If there's something you don't understand, ask the assistant to clarify.
-
Once the assistant has finished configuration of assets, review and confirm what it created by browsing the configuration in API Manager. If any settings are not as expected, you can ask the assistant to edit them or edit them directly.
Limitations
The following interactions are not yet supported:
- Test custom APIs.
- Create and edit proxy APIs.
- Export and import APIs.
Known issue
When the assistant prompts you to select an environment, the list may be outdated if you have made changes to environments in the same browser session. As a workaround, log out of the Harmony portal and log in for the assistant to return an updated list of environments.