Overview

Tools enhance your AI by connecting it to various apps and services, enabling it to fetch real-time information, update your CRM, send notifications, and much more. They keep your AI up to date and help you get things done efficiently!

How to create a tool

Tools are contained within your project to ensure that sensitive tools aren’t accidentally activated in public projects. You can create a custom tool directly within your project or start with one of our templates.

A custom tool relies on an API request executed by the AI model. You can set this up easily using our step-by-step wizard in just 3 simple steps.

Tool Prompts

• Name: Give your tool a unique name within your project.

• Description: Clearly explain what your tool does and what kind of response it will generate.

• When to Call: Specify exactly when the model should use this tool.

Example:

name: "get_current_weather"
description: "Get the current weather in a given location"
when to call: "When the users ask for the weather use get_current_weather"

Parameters

Specify the parameters your AI model must provide to your tool. These parameters are defined using a JSON schema, allowing you to leverage its rich features for validation and structure.

If no parameters are defined, the AI model will execute your tool without passing any parameters.

Parameters

API configuration

In the final step, you can configure your API using our API builder.

By default, parameters are passed directly into the request body. However, you can override this with a custom request body if needed. This allows you to include additional information, such as conversation context or other values, without requiring the AI model to request them from the user.

Template variabels

In your API setup, you can use variables in the URL, query parameters, headers, and body. These templates will automatically be replaced with the corresponding values when the tool is called.

Template key	Description
{{parameter_key}}	Access your parameters
{{context.your_key}}	Access the context you've provided to the SDK
{{customer.id}}	Get the id of the conversations customer
{{customer.email}}	Get the email of the conversations customer
{{customer.firstName}}	Get the first name of the conversations customer
{{customer.lastName}}	Get the last name of the conversations customer
{{customer.avatar}}	Get the avatar of the conversations customer
{{project._id}}	Get the id of the project
{{project.name}}	Get name of the project
{{organization._id}}	Get the organization id
{{organization.name}}	Get the name of the organization