|
1 | 1 | --- |
2 | 2 | title: Dashboard |
3 | | -subtitle: Quickstart with the Vapi web dashboard. |
| 3 | +subtitle: Learn to build a voice agent in under 5 minutes. |
4 | 4 | slug: quickstart/dashboard |
5 | 5 | --- |
6 | 6 |
|
7 | | -<Frame> |
8 | | - <div class="video-embed-wrapper"> |
9 | | - <iframe |
10 | | - src="https://www.youtube.com/embed/sFXaTsmMR8s?si=aV-mAdjwkpHchHfT" |
11 | | - title='An embedded YouTube video titled "Quickstart: Vapi Dashboard"' |
12 | | - frameborder="0" |
13 | | - allow="fullscreen; accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" |
14 | | - allowfullscreen |
15 | | - referrerpolicy="strict-origin-when-cross-origin" |
16 | | - /> |
17 | | - </div> |
18 | | -</Frame> |
| 7 | +## Overview |
19 | 8 |
|
20 | | -### The Web Dashboard |
| 9 | +Vapi makes it easy to build end-to-end voice agents, which we call ***assistants***. Assistants support live, two-way conversations. You can call an assistant or have it call you. |
21 | 10 |
|
22 | | -One of the easiest ways to get started with Vapi is by using the web dashboard. |
| 11 | +Each assistant is powered by three components: |
23 | 12 |
|
24 | | -<Note> |
25 | | -You can visit your dashboard by going to [dashboard.vapi.ai](https://dashboard.vapi.ai) |
26 | | -</Note> |
| 13 | +- Speech-to-text (STT) |
| 14 | +- Language model (LLM) |
| 15 | +- Text-to-speech (TTS) |
27 | 16 |
|
28 | | -The web dashboard gives you the ability to: |
| 17 | +Vapi gives you full control over each, with dozens of providers and models to choose from. |
29 | 18 |
|
30 | | -- **view, create, & modify [assistants](/assistants)** associated with your account |
31 | | -- **provision & manage phone numbers** assistants can dial outbound from or receive inbound calls to |
32 | | -- **review conversation data** (such as audio recordings, call metadata, etc) |
33 | | -- **manage your [provider keys](/customization/provider-keys)** (used in communication with external [TTS](/glossary#tts), LLM, & [STT](/glossary#stt) vendors) |
| 19 | +In this quickstart, you’ll learn to: |
| 20 | +- Create an assistant in the Vapi dashboard |
| 21 | +- Pick your STT, LLM, and TTS providers |
| 22 | +- Attach a phone number |
| 23 | +- Make your first call over the web or by phone |
34 | 24 |
|
35 | | -We will be walking through the core necessities you need to get up and running in this guide. |
| 25 | +## Prerequisites |
36 | 26 |
|
37 | | -<Tip> |
38 | | - The web dashboard wraps over much of the realtime call functionality of Vapi. The dashboard |
39 | | - actually uses the [web SDK](/sdk/web) beneath-the-hood to make web calls. |
40 | | -</Tip> |
| 27 | +- [A Vapi account](https://dashboard.vapi.ai) |
41 | 28 |
|
42 | | -## Vapi’s Pizzeria |
| 29 | +## Get started |
43 | 30 |
|
44 | | -In this guide we will be implementing a simple order-taking assistant at a pizza shop called “Vapi’s Pizzeria”. |
| 31 | +<Steps> |
| 32 | + <Step title="Open the Vapi Dashboard"> |
| 33 | + Go to [dashboard.vapi.ai](https://dashboard.vapi.ai) and log in to your account. |
| 34 | + </Step> |
45 | 35 |
|
46 | | -Vapi’s has 3 types of menu items: `pizza`, `side`s, & `drink`s. Customers will be ordering 1 of each. |
| 36 | + <Step title="Create Your Assistant"> |
| 37 | + In the Vapi dashboard, create a new assistant using the customer support specialist template. |
47 | 38 |
|
48 | | -<Frame caption="Customers will order 3 items: 1 pizza, 1 side, & 1 drink. The assistant will handle the full order taking conversation."> |
49 | | - <img src="../static/images/quickstart/vapis-pizzeria.png" /> |
50 | | -</Frame> |
51 | | - |
52 | | -## Assistant Setup |
53 | | - |
54 | | -First we're going to set up our assistant in the dashboard. Once our assistant’s **transcriber**, **model**, & **voice** are set up, we can call it to place our order. |
55 | | - |
56 | | -<Note> |
57 | | -You can visit your dashboard at [dashboard.vapi.ai](https://dashboard.vapi.ai/) |
58 | | -</Note> |
59 | | - |
60 | | -<Markdown src="../snippets/quickstart/dashboard/assistant-setup-inbound.mdx" /> |
61 | | - |
62 | | -## Calling Your Assistant |
63 | | - |
64 | | -Now that your assistant is fully setup & configured, we will want to contact it. There are 2 ways to "call in" to an assistant: |
65 | | - |
66 | | -- **Over the Internet:** Network-enabled devices can contact Vapi via the Internet (i.e. web applications, mobile applications). No phone number is involved. |
67 | | -- **Via Telephony:** Phones can communicate to Vapi over a cellular network (i.e. phone call). One phone number dials to another phone number. |
68 | | - |
69 | | -For our use case, it is most appropriate that customers will contact our assistant via an inbound |
70 | | -phone call. Though, we will look at both ways of calling in. |
71 | | - |
72 | | -<AccordionGroup> |
73 | | - <Accordion title="Call in the Dashboard" icon="camera-web" iconType="solid"> |
74 | | - The quickest way to contact your new assistant is by simply using the call button on the assistant detail page: |
75 | | - |
76 | | - <Frame caption="Call into your assistant via the dashboard."> |
77 | | - <img src="../static/images/quickstart/dashboard/call-assistant-web-dashboard.png" /> |
| 39 | + <Frame caption="Creating a new assistant"> |
| 40 | + <img src="../static/gifs/create-assistant.gif" /> |
78 | 41 | </Frame> |
| 42 | + </Step> |
| 43 | + |
| 44 | + <Step title="Configure your assistant"> |
| 45 | + <Steps> |
| 46 | + <Step title="First message"> |
| 47 | + Set the first message that the assistant will speak when a conversation is started with it. |
| 48 | + |
| 49 | + ```plaintext First message |
| 50 | + Hi there, this is Alex from TechSolutions customer support. How can I help you today? |
| 51 | + ``` |
| 52 | + </Step> |
| 53 | + |
| 54 | + <Step title="System prompt"> |
| 55 | + Set the system prompt, which sets the context, role, personality and instructions that will guide your assistant. |
| 56 | + |
| 57 | + ```plaintext System Prompt |
| 58 | + You are Alex, a customer service voice assistant for TechSolutions. Your primary purpose is to help customers resolve issues with their products, answer questions about services, and ensure a satisfying support experience. |
| 59 | + - Sound friendly, patient, and knowledgeable without being condescending |
| 60 | + - Use a conversational tone with natural speech patterns, including occasional "hmm" or "let me think about that" to simulate thoughtfulness |
| 61 | + - Speak with confidence but remain humble when you don't know something |
| 62 | + - Demonstrate genuine concern for customer issues |
| 63 | + ... |
| 64 | + ``` |
| 65 | + </Step> |
| 66 | + </Steps> |
| 67 | + </Step> |
| 68 | + |
| 69 | + <Step title="Configure the models for your assistant"> |
| 70 | + <Steps> |
| 71 | + <Step title="Set the LLM (large language model)"> |
| 72 | + Select your preferred provider and the large language model (LLM) that will power your assistant (default gpt-4o). |
| 73 | + |
| 74 | + <Frame> |
| 75 | + <img src="../static/images/quickstart/dashboard/set-llm.png" /> |
| 76 | + </Frame> |
| 77 | + </Step> |
79 | 78 |
|
80 | | - <Tip>The dashboard uses the [web SDK](/sdk/web) underneath to make web calls.</Tip> |
81 | | - |
82 | | - This will start a web call with your assistant, you can now speak to it to order your pizza & sides! |
83 | | - |
84 | | - </Accordion> |
85 | | - <Accordion title="Call via Phone" icon="phone-arrow-up-right" iconType="solid"> |
86 | | - Since our assistant is meant to take orders over the phone, we will want to set up [inbound calling](/phone-calling) to our assistant. We will need to do 2 things: |
87 | | - |
88 | | - 1. **provision a new phone number** to sit our agent behind (it will pick-up calls that come in — hence "inbound calling") |
89 | | - 2. **place our agent behind that phone number** |
90 | | - |
91 | | - If you already have your own phone numbers (purchased via Twilio or Vonage, etc), you can import |
92 | | - them into Vapi for use. Learn more about [telephony](/phone-calling) on Vapi. |
93 | | - |
94 | | - <AccordionGroup> |
95 | | - <Accordion title="Provision a Phone Number" icon="hashtag" iconType="solid"> |
96 | | - <Markdown src="../snippets/quickstart/dashboard/provision-phone-number-with-vapi.mdx" /> |
97 | | - </Accordion> |
98 | | - <Accordion title="Attach Your Assistant" icon="user-robot" iconType="solid"> |
99 | | - In the `Inbound` area of the phone number detail view, select your assistant in the dropdown under `Assistant`. |
| 79 | + <Step title="Set the transcriber (speech-to-text) model"> |
| 80 | + In the transcriber tab, choose the transcriber (speech-to-text, STT) model that will convert your callers' speech into text for your assistant to process. |
100 | 81 |
|
101 | | - <Frame caption="Your assistant will now pick-up calls made to this phone number."> |
102 | | - <img src="../static/images/quickstart/dashboard/inbound-assistant-set.png" /> |
| 82 | + <Frame> |
| 83 | + <img src="../static/images/quickstart/dashboard/set-transcriber.png" /> |
103 | 84 | </Frame> |
104 | 85 |
|
105 | | - This will put your assistant behind the phone number for inbound calls. Your assistant is now ready to take calls. |
106 | | - </Accordion> |
107 | | - </AccordionGroup> |
| 86 | + <Tip> |
| 87 | + Vapi was made for model selection to be configurable - try playing around with different models! |
| 88 | + </Tip> |
| 89 | + </Step> |
108 | 90 |
|
109 | | - </Accordion> |
110 | | -</AccordionGroup> |
111 | | - |
112 | | -Your assistant should be able to accept calls & maintain a basic conversation. Happy ordering! |
| 91 | + <Step title="Choose the voice (text-to-speech) model"> |
| 92 | + In the voice tab, select the voice (TTS) model that will determine how your assistant sounds to callers. |
| 93 | + |
| 94 | + <Frame> |
| 95 | + <img src="../static/images/quickstart/dashboard/set-voice.png" /> |
| 96 | + </Frame> |
113 | 97 |
|
114 | | -<Tip> |
115 | | - Your assistant won't yet be able to hang-up the phone at the end of the call. We will learn more |
116 | | - about configuring call end behaviour in later guides. |
117 | | -</Tip> |
| 98 | + Just like with the transcriber, you can plug in any provider! |
| 99 | + </Step> |
| 100 | + </Steps> |
| 101 | + </Step> |
| 102 | +</Steps> |
| 103 | + |
| 104 | +## Call your assistant |
| 105 | +<Steps> |
| 106 | + <Step title="Call your assistant in the dashboard"> |
| 107 | + Try calling your assistant by clicking the call button in the dashboard. |
| 108 | + <Frame> |
| 109 | + <img src="../static/gifs/dashboard-call.gif" /> |
| 110 | + </Frame> |
| 111 | + </Step> |
| 112 | + <Step title="Call your assistant by phone"> |
| 113 | + <Steps> |
| 114 | + <Step title="Create a new number"> |
| 115 | + In the Phone Numbers tab, you can create a free new number or import an existing number from another telephony provider (Twilio, Vonage, Telnyx, etc.). |
| 116 | + <Frame caption="Attach a phone number to your assistant"> |
| 117 | + <img src="../static/gifs/create-number.gif" /> |
| 118 | + </Frame> |
| 119 | + </Step> |
| 120 | + <Step title="Attach a phone number to your assistant"> |
| 121 | + Select your assistant in the inbound settings for your phone number. Whenever this number is called, your assistant will pick up and have a conversation with them! |
| 122 | + <Frame> |
| 123 | + <img src="../static/images/quickstart/dashboard/set-assistant-number.png" /> |
| 124 | + </Frame> |
| 125 | + </Step> |
| 126 | + </Steps> |
| 127 | + </Step> |
| 128 | +</Steps> |
0 commit comments