Design with AI
API Hub for Design provides AI-powered features allowing you to create, edit, or enhance OpenAPI and AsyncAPI definitions. By describing an API in natural language, you can automatically generate or update a complete API definition, streamlining the design process and reducing the need for manual editing. The APIs generated with AI aim to align with the standardization rules defined in your organization.
Create a new API
To generate a new API with the help of AI features, perform the following steps:
Select the Generate with AI tile visible on API Hub for Design landing page.
Alternatively, click Create New, and select Generate with AI.
Provide details of the API you want to create by selecting the relevant specification and (optionally) project in the Generate API with AI dialog. To improve accuracy, reference a template to help the AI better understand the type of definition you want to create, and generate a more aligned output.
Enter a prompt describing your API. Based on this natural language description, AI will generate a definition that you can then further refine, if necessary. For best results, provide a detailed and precise prompt.
(Optional) Alternatively, select the try an example option to have AI provide an example prompt you can use as a reference.
Edit an API
With AI, you can also update your existing APIs by describing the desired enhancements in natural language.
Perform the following steps to edit an API:
Open the API in the Code Editor and click the Open AI icon on the toolbar.
Navigate to the Edit and Improve API with AI input available in the AI tab.
Enter a prompt detailing the updates you want to make to your API definition.
After AI applies the requested modifications to your API definition, API Hub for Design revalidates the API against your organization's standardization rules and display an updated list of errors. You can preview the changes implemented by AI in Diff Mode.
Resolve standardization errors
AI-powered features in API Hub for Design can also assist you in resolving standardization errors displayed after creating or editing an OpenAPI or AsyncAPI definition.
Once the Code Editor has listed the detected standardization issues below the editing field, resolve each using the Fix with AI option in the corresponding row:
To keep the resolution process consistent and transparent, you can only fix standardization errors individually, one at a time.
Enable or disable AI
As an organization administrator, you can choose whether to enable AI features for your organization. If you disable the feature, all AI components are hidden from the application interface.
To configure this setting, perform the following steps:
Go to Organization Settings.
In the AI Features section, toggle Enable AI features on or off.