Tools Quickstart
Learn how to start using built-in tools and how to create custom tools.
This quickstart contains two parts. This guide will use the Ultravox Web App but you can also use the Ultravox API if you prefer (not covered in this guide).
Part 1: Using the Built-in Hang Up Tool
Add the hangUp
tool so the agent can end the call at the right time.
Part 2: Creating a Custom Tool
Create a custom tool that retrieves information from a 3rd party API and provides the information to the user.
Using the Built-in hangUp
Tool
Start with the Ultravox Console
Go to Agents.
Create a New Agent
Click on New Agent
in the top right corner.
Enter a Name and Prompt
Copy & paste the following for the name of your agent:
Next, copy and paste this system prompt:
Add the hangUp Tool
Use the Tools
drop-down and select the hangUp
tool.
Save & Test the Agent
-
Save the agent using the
Save
button. This agent will be used in part two of this quickstart. -
Start a call with your agent by clicking the
Test Agent
button on the bottom right. -
When you say the word “Oklahoma”, the agent will call the tool and the call will end and you will see the call state change to
DISCONNECTED
.
Creating a Custom Tool
This part uses the Tools_Agent
we created above in Using Built-in Tools.
Create the getAdvice Tool
Under Tools
click on New Tool. Set properties as follows and then click on Save
:
Tool Name:
Description:
Custom Endpoint URL:
Edit Tools_Agent
- Go to Agents
- Click
...
on the right side of ourTools_Agent
- Choose
Edit
Add the getAdvice Tool
Use the Tools
drop-down and select the getAdvice
tool. You can keep the hangUp
tool selected.
Update Prompt
Copy & paste the following for the system prompt:
Save & Test the Agent
-
Save the agent using the
Save
button. -
Start a call with your agent by clicking the
Test Agent
button on the bottom right. -
If you ask for advice, the agent will now use the tool to get random advice from the adviceslip API.
-
Saying “Oklahoma” will continue to trigger the hangUp tool.
Next Steps
- Learn more about Built-in Tools you can use.
- Dig into HTTP vs. Client Tools to understand the differences.
- Read about Durable vs. Temp Tools.