API tool
An API AI tool allows you to add a usable AI tool on top of an API operation.
To create it, select an operation from an API and provide a descriptive but concise explanation of the functionality of the API. The AI tool will autogenerate the interface for query parameters and the request body from the API definition.
| It is important to have descriptions on all query parameters and the request body. To do this, go to the API Designer and in Operations → Request, enter values into the Documentation dialog by selecting the information icon for the query parameters and request body respectively. Ideally, also provide examples for these in the API. Ensure to appropriately fill the Description parameter as AI tools used for API execution source this information. Providing this kind of context will help the AI decide what values it should enter when executing the AI tool. See Add URL parameters in API operations. |