Skip to main content

How to Configure AI Agent Custom Plugins

AI Agent custom plugins allow you to seamlessly integrate your own HTTP Apis into AI Agent, making them powerful tools available to the Agent.

1. Plugin Working Principle​

The core principle of AI Agent custom plugins is that they can transform your HTTP Apis into tools that AI Agent can understand and call. You need to use the OpenAPI Specification format in custom plugins to provide detailed descriptions of your Apis, including request methods, request addresses, input parameters, output parameters, etc. Through this standardized description, AI can understand your Api functionality and automatically call it when needed.

2. Custom Plugin Entry Point​

To add a custom plugin, please follow these steps: Custom Plugin Page Navigation

3. Custom Plugin Configuration Details​

In the opened configuration form, you need to fill in relevant information to define your plugin. Here are detailed explanations for each parameter: Custom Plugin Page Navigation

  • Code: This is the unique identifier for the plugin, which must be non-duplicate English content. To facilitate AI understanding and usage, please try to use a meaningful name, such as get_weather_info or send_email_notification.
  • Name: The name of the plugin, used for display in the system.
  • Description: A brief description of the plugin's functionality. This description is crucial for AI to understand the plugin's purpose, so please clearly and accurately explain what the plugin can do.
  • Request Header: If your Api requires authentication, you can configure request header information here, such as setting Authorization or Token for verification.
  • OpenAPI / Swagger Schema (JSON): This is the most critical part of the configuration, used to describe your Api.

About OpenAPI / Swagger Schema (JSON)​

OpenAPI Specification (OAS) is a standard format for describing RESTful APIs. It defines various API information in JSON format, including:

  • Server address
  • All available paths (endpoints)
  • Request methods for each path (GET, POST, etc.)
  • Request parameters
  • Response content
  • Authentication methods If you want to learn more about this standard, you can visit the official documentation: OpenAPI Specification.

Let AI Help You Generate OpenAPI JSON​

To simplify this process, you can directly ask AI to help you generate this JSON content. Use the following prompt and replace the placeholder content:

Please help me generate a JSON object that complies with OpenAPI 3.0 specification based on the following Api information:

Api URL: ${your Api URL}
Api Method: ${GET/POST/PUT/DELETE}
Api Input Parameters: ${parameter list including parameter name, type, required status, description}
Api Output Parameters: ${return content structure}
Api Description: ${brief description of the Api functionality}

Copy and paste the JSON content generated by AI into the OpenAPI / Swagger Schema (JSON) input box.