Custom Actions/APIs
Custom web requests for your bot to use.
Only available on custom plan. Please contact support to enable this.
What is Custom Action?
The Custom Action tool allows you to define custom web requests for the bot to use.
Name
Name of your custom action. This will determine how the action can be called inside of your custom prompt. The name will be automatically converted to custom_api_<name>.
URL
Endpoint you want to make a request to. Query parameters are supported. Example:
https://your-domain.com/path?q={{param}}Payload Template (Optional)
Request body to be sent to the endpoint. Can be empty. Example:
{
"fieldName": "value",
"anotherField": "{{param2}}" // this can be passed in by the AI by configuring the prompt
}Headers (Optional)
Request headers to be sent to the endpoint. Can be empty.
How to use?
You can use the tool just like any other existing tools. Refer to the following guide for more information.
In the sidebar, click on Customize to open up the customize fly-out.
In the fly-out, click on Create new action.
Then look for Custom Action.
Finally, define your custom web request and hit Create Custom Web Request. Once created, custom action will appear under Actions.
In order to use the tool, you can invoke it just like how you would with any of the other existing tools.
For example, to retrieve the last n results from an endpoint, we can add the following prompt.
Invoke `custom_api_get_posts` to get the last 5 posts' <titles> and <ids>.Afterwards, we can tell the bot to respond with the retrieved values.
Reply with the following in markdown:
<a bulleted list of <ids> and <titles>>Last updated