Use the Jitterbit API Manager AI Assistant

Introduction

Using written natural language, the APIM AI Assistant helps you create and maintain assets in API Manager, and query, explain, and download API analytics data.

Access the APIM AI Assistant

Access the assistant from these places:

• In the Harmony portal header on any API Manager or Studio page, use the Jitterbit AI icon. In the panel, use the dropdown to select APIM AI Assistant.

• From these API Manager pages, click New > Build with AI:

  • APIs
  • Security Profiles
  • API Groups
  • Trusted IP Groups

• On the Analytics page, click Ask AI.

• In Studio, use the operation actions menu to select Publish as an API using AI.

• On the Management Console's AI Assistant page, access the dedicated full-page interface for extended conversations.

APIM AI Assistant controls

The APIM AI Assistant panel includes these controls:

• Home: Return to the current chat from chat history.
• History: Browse your previous AI Assistant chats and select one to view.
• Copy chat: Copy the full conversation to the clipboard.
• New chat: Start a new chat.
• Users chat: View chat history for a specific user by selecting their email address. This option is available only to users with Admin permission.
• Expand: Expands the chat. Once expanded, click the Minimize icon to return to the previous view.
• Resize: Drag the left edge of the panel to adjust its width.

Supported interactions and capabilities

The following interactions and capabilities are supported:

• Custom APIs: Create, publish, edit, test, clone, and delete.
• Proxy APIs: Create, publish, edit, and test.
• Security profiles: Create, edit, assign, and delete.
• Trusted IP groups: Create, edit, assign, and delete.
• API groups: Create, edit, assign, and delete.

• API information: Get detailed explanations and insights about existing APIs.

  Tip

  The assistant provides richer and more detailed explanations when your API includes comprehensive descriptions and OpenAPI documentation.

• Analytics: Query, explain, summarize, and download API analytics data, including API calls, response time, status codes, errors, rate-limit utilization, policy violations, and consumer and IP insights.

Get started

To get started using the APIM AI Assistant, use natural language to tell the assistant what you would like it to do. The assistant will guide you through the process of creating or updating assets. It will ask for confirmation when needed, prompt you when it requires more information, and confirm when it has performed an action.

If you need help understanding how to respond to the assistant, ask it to clarify what it means or use the UI documentation as a supplemental reference.

APIs

You can create, edit, publish, test, clone, and delete APIs.

When you ask the assistant to delete an API, it will warn you if the API is currently published, ask you to verify you want to delete it, and confirm when it has been successfully deleted.

When you clone a custom API, the cloned API's name will be prepended with Copy of, the service root prepended with Copyof, and the version appended with an incremented number.

When the assistant is testing an API secured with basic authentication, it will provide a separate UI dialog to enter your credentials for security purposes. Your credentials are not shared with the large language model (LLM).

Security profiles

You can create, edit, assign, and delete security profiles, either while creating or editing an API, or as a separate interaction.

API groups

You can create, edit, assign, and delete API groups.

Trusted IP groups

You can create, edit, assign, and delete trusted IP groups.

Analytics

You can ask the assistant to query, explain, summarize, and download data from the Analytics page. The assistant automatically uses the environment, time range, API, version, method, status code, and profile filters currently applied on the Analytics page, so you don't need to restate that context in your prompt.

When a request requires filtering the data, for example "show only 4xx errors" or "filter to this API," the assistant applies the corresponding filter on the Analytics page.

You can also ask analytics questions from other API Manager pages. The assistant navigates you to the Analytics page to answer them.

You can also ask the assistant to expand or collapse an individual chart. The assistant does this only when you ask it to.

You can also ask the assistant to download data from the API health monitoring table or from the charts within the Call metrics and API consumers sections as a CSV file, matching the Download as CSV behavior for the table and the Download as CSV behavior for individual charts. The assistant applies the filters currently active on the Analytics page to the download.

Recommendations

You should interact with the APIM AI Assistant as you would with any large language model (LLM) AI product. Follow these suggestions:

• 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 assistant's responses carefully before typing your reply. If there's something you don't understand, ask the assistant to clarify.

• Once the assistant has performed an action, you can review and confirm what it did by browsing the configuration in the UI. 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:

• Clone and delete proxy APIs.
• Export and import APIs.
• Upload an OpenAPI document while creating a proxy API.
• Predictive analytics, automatic remediation, or alert creation from analytics data.
• Analytics reports or exports beyond CSV download.