Using the API Assistant to improve your API specifications
You can use the API Assistant to analyze your OpenAPI 3.0 specifications, and generate AI recommendations for validation fixes, and documentation enhancements. Improving your API specifications accelerates their adoption by consumers.
About
The API Assistant in IBM® API Connect Enterprise as a Service uses IBM watsonx Granite LLM models to help you build your APIs faster. Take advantage of the API Assistant to quickly generate AI fixes for your API definitions, and suggest helpful descriptions and examples for your API documents.
The API Assistant consists of the following two components:
- Specification validation errors
- Improve your API by analyzing your OpenAPI 3.0 specification, and generating potential AI fixes for any validation errors; see Using the API Assistant for error remediation.
- Specification enhancements
- Improve your API documentation by analyzing your API definition, and generating recommendations for your descriptions and examples; see Using the API Assistant to document your APIs.
Limitations
The API Assistant feature is subject to a rate limit on calls to the AI generator. For best performance, use API Assistant on moderately sized APIs.
In addition, the following limitations apply:
- You must use an Advanced subscription. For information about the different subscriptions and how to upgrade, see Purchase, subscription, and upgrade information.
- You must work online in API Manager (working locally in API Designer is not supported).
- Your API definition must conform to the OpenAPI 3.0 specification (OpenAPI 2.0 is not supported).