Built-in tools
Vapi voice assistants are given additional functions: transferCall, endCall, sms, dtmf (to dial a keypad with DTMF), and apiRequest. These functions can be used to transfer calls, hang up calls, send SMS messages, press keys on the keypad, and integrate business logic with your existing APIs.
To add built-in tools to your agent, you need to add them in the tools array of your assistant. You can do this in your api request, or by creating a new tool in the dashboard tools page, and assigning it to your assistant.
Transfer Call
Hang Up
Send Text
This function is provided when sms is included in the assistant’s list of available tools. For configuration options, see Create Tool. The assistant can use this function to send SMS messages using a configured Twilio account.
Dial Keypad (DTMF)
API Request
Use an API Request Tool to call an HTTP endpoint during a conversation and make the response available to the assistant.
Custom Functions: Deprecated
Custom Functions
In addition to the predefined functions, you can also define custom functions. These functions are similar to OpenAI functions and your chosen LLM will trigger them as needed based on your instructions.
The functions array in the assistant definition allows you to define custom functions that the assistant can call during a conversation. Each function is an object with the following properties:
name: The name of the function. It must be a string containing a-z, A-Z, 0-9, underscores, or dashes, with a maximum length of 64.description: A brief description of what the function does. This is used by the AI to decide when and how to call the function.parameters: An object that describes the parameters the function accepts. The type property should be “object”, and the properties property should be an object where each key is a parameter name and each value is an object describing the type and purpose of the parameter.
Here’s an example of a function definition:
In this example, the bookAppointment function accepts one parameter, datetime, which is a string representing the date and time of the appointment in ISO format.
In addition to defining custom functions, you can specify a serverUrl where Vapi will send the function call information. This URL can be configured at the account level or at the assistant level.
At the account level, the serverUrl is set in the Vapi Dashboard. All assistants under the account will use this URL by default for function calls.
At the assistant level, the serverUrl can be specified in the assistant configuration when creating or updating an assistant. This allows different assistants to use different URLs for function calls. If a serverUrl is specified at the assistant level, it will override the account-level Server URL.
If the serverUrl is not defined either at the account level or the assistant level, the function call will simply be added to the chat history. This can be particularly useful when you want a function call to trigger an action on the frontend.
For instance, the frontend can listen for specific function calls in the chat history and respond by updating the user interface or performing other actions. This allows for a dynamic and interactive user experience, where the frontend can react to changes in the conversation in real time.