Custom Actions/APIs

Custom web requests for your bot to use.

What is Custom Action?

The Custom Action tool allows you to define custom web requests for the bot to use.

custom action tool
Preview of custom action tool (subject to change)
Fields
Description

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.

You can have multiple instances of custom action.

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.

Last updated