Help

The Help tool provides interactive help for using the API Agent and related tools.

The API Agent help tool is an interactive guide for navigating API Agent and related tools. It provides step-by-step assistance, example prompts, and contextual suggestions. You can use the help tool to complete the following actions:

Create and design new APIs.
Manage the API lifecycle in API Connect.
Troubleshoot issues.

To get started, in the Type something field, enter help or How do you work? Help with your capabilities. You can also ask specific questions or request help for a task.

Note: Before you use the Help tool, make sure that you open a new chat window.

Scope and purpose

The Help tool offers a comprehensive guide to the API Agent system. It includes in-context help, message-specific assistance, and automated support for tasks such as

Creating and designing new APIs
Managing the API lifecycle on API Connect
Troubleshooting issues

Capabilities

Displays the available functions and provides guidance on how to use them. Presents an overview of supported features and offers usage examples. This capability helps you understand what the tool can do and how to interact with it effectively.

The following table describes about the prompts that you can enter and how help tool assists you run them correctly.

Example prompts	Description
`How do you work? Help me with your capabilities`	Displays a list of capabilities, usage guidelines, and outlines prompts examples which you can try.

API and test case publishing

Displays the available methods for publishing APIs and test cases and provides guidance on when and how to use each method. The Help tool shows different options for publishing APIs and creating a API with explanation the purpose of each method. The help tool guides that you choose the right publishing approach and understand how to implement it effectively.

The following table describes about the prompts that you can enter and how Help tool assists you run them correctly.

Example prompts	Description
`How can I publish an API in APICONNECTTASK?`	Displays a list of available operations that are related to API publishing along with short description explaining when or why to use it.

Tool description and supported operations

Displays detailed information about a specific tool and lists the operations that it supports. This capability allows the Help tool to provide a clear description of the selected tool and outline its main functions. It helps you understand the tool’s purpose and how to use its operations effectively.

The following table describes the prompts that you can enter and how Help tool assists you in running them correctly:

Example prompts	Description
`Tell me about {tool name}`	Displays a detailed description and supported operations about the tool.

Operation description within a tool

Displays detailed information about a specific operation within a tool, including its purpose, inputs, outputs, and usage context. This capability allows the Help tool to explain how the operation works and when to use it. It helps you understand the operation’s role and apply it correctly in your workflow.

The following table describes the prompts that you can enter and how Help tool assists you in running them correctly:

Example prompts	Description
`Tell me about {operation name} in {tool name}` `How can I < operation name> in <Toolname>`	Displays a detailed description of the operation, including its purpose, required parameters, expected outputs, and usage.