The GET route custom plugin in TeamAI allows your AI model or assistant to communicate with external APIs using the HTTP GET method. By configuring this plugin, you can enable your AI to retrieve data from various sources, enhancing its capabilities and providing more accurate and up-to-date information to users.
Creating a GET Route Custom Plugin
To create a GET route custom plugin, follow these steps:
Navigate to the "Custom plugins" section in the left sidebar of your TeamAI dashboard.
Click on the "Create plugin" button.
Name your plugin and click "Create."
In the "Endpoint" field, enter the URL of the API endpoint you want to connect to.
In the "Method" dropdown, select "GET."
Configuring Query Parameters and Headers
The GET route custom plugin supports both query parameters and headers. Query parameters are key-value pairs appended to the end of the API URL, while headers provide additional information about the request.
To add query parameters or headers:
In the plugin configuration, locate the "Query Parameters" or "Headers" section.
Click on the "Add Parameter" or "Add Header" button.
Enter the key and value for the parameter or header.
Click "Save" to apply the changes.
Using Dynamic Parameters (Variables)
Dynamic parameters, or variables, allow you to create flexible and reusable plugins. By defining variables, you can enable the AI model to input values based on the user's query when the plugin is toggled.
To create a new parameter:
In the plugin configuration, click on the "Add property" button in the "Parameters" section.
Enter a meaningful name and description for the parameter, as these will be used by the AI model.
Select the appropriate type for the parameter (e.g., string, number, boolean).
Click "Save" to add the parameter.
To use a dynamic parameter in query parameters or headers, simply reference the variable name wrapped in double curly braces, like this: {{variableName}}.
Example: Using a Dynamic Parameter
Let's say you've created a dynamic parameter called postId. To use this parameter in a query parameter, you would enter the following in the "Key" field: postId, and in the "Value" field: {{postId}}.
When the AI model processes a user's query with this plugin toggled, it will attempt to input a value for the postId parameter based on the context of the query.
Conclusion
The GET route custom plugin in TeamAI is a powerful tool for enabling your AI model or assistant to interact with external APIs. By configuring query parameters, headers, and dynamic parameters, you can create flexible and reusable plugins that enhance your AI's capabilities.
Feel free to experiment with different configurations and test your plugin with various user queries to ensure it functions as expected. With the GET route custom plugin, you can unlock new possibilities for your AI model and provide even more value to your users.