Skip to content

Commit 2bf16d1

Browse files
committed
reorganize sidebar to match dashboard
1 parent 9994117 commit 2bf16d1

File tree

27 files changed

+333
-324
lines changed

27 files changed

+333
-324
lines changed

fern/advanced/sip/sip-telnyx.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Set as follows:
6666
Go to numbers tab, assign number
6767
</Step>
6868
<Step title="Modify SIP invite">
69-
Modify SIP invite so your VAPI and Telnyx accounts will be matched correctly
69+
Modify SIP invite so your Vapi and Telnyx accounts will be matched correctly
7070
1. Go to numbers, edit the one your will be using
7171
2. Navigate do voice
7272
3. Scroll down till the end to find Translated Number
@@ -84,7 +84,7 @@ Modify SIP invite so your VAPI and Telnyx accounts will be matched correctly
8484
<Step title="Set outbound authentication method">
8585
1. Go to Voice / Sip Trunking / Authentication and routing
8686
2. Scroll down to outbound calls authentication and:
87-
- Add the two fixed IPs from VAPI, select Tech Prefix and create a unique 4-digits Tech Prefix (example 1234 - don't use 1234, must be unique to your account)
87+
- Add the two fixed IPs from Vapi, select Tech Prefix and create a unique 4-digits Tech Prefix (example 1234 - don't use 1234, must be unique to your account)
8888
<Frame>
8989
<img src="../../static/images/sip/telynx-outbound-auth.png" />
9090
</Frame>

fern/apis/api/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14091,7 +14091,7 @@
1409114091
},
1409214092
"variableValues": {
1409314093
"type": "object",
14094-
"description": "These are values that will be used to replace the template variables in the assistant messages and other text-based fields.\nThis uses LiquidJS syntax. https://liquidjs.com/tutorials/intro-to-liquid.html\n\nSo for example, `{{ name }}` will be replaced with the value of `name` in `variableValues`.\n`{{\"now\" | date: \"%b %d, %Y, %I:%M %p\", \"America/New_York\"}}` will be replaced with the current date and time in New York.\n Some VAPI reserved defaults:\n - *customer* - the customer object"
14094+
"description": "These are values that will be used to replace the template variables in the assistant messages and other text-based fields.\nThis uses LiquidJS syntax. https://liquidjs.com/tutorials/intro-to-liquid.html\n\nSo for example, `{{ name }}` will be replaced with the value of `name` in `variableValues`.\n`{{\"now\" | date: \"%b %d, %Y, %I:%M %p\", \"America/New_York\"}}` will be replaced with the current date and time in New York.\n Some Vapi reserved defaults:\n - *customer* - the customer object"
1409514095
},
1409614096
"name": {
1409714097
"type": "string",

fern/apis/webhooks/openapi.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.0
22
info:
3-
title: VAPI Webhooks API
3+
title: Vapi Webhooks API
44
servers:
55
- url: https://{yourserver}.com
66
paths:

fern/calls/voice-mail-detection.mdx renamed to fern/calls/voicemail-detection.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ If a lot of your calls are landing in voicemail, you could be spending too much
66

77
### **The Solution: Early Voicemail Detection**
88

9-
By detecting voicemail right away, your VAPI Assistant can either hang up (if leaving a message isn’t necessary) or smoothly play a recorded message. This cuts down on useless call time and makes your entire call flow more efficient.
9+
By detecting voicemail right away, your Vapi Assistant can either hang up (if leaving a message isn’t necessary) or smoothly play a recorded message. This cuts down on useless call time and makes your entire call flow more efficient.
1010

1111
## **Two Ways to Detect Voicemail**
1212

1313
### **1. Using Twilio’s Voicemail Detection**
1414

15-
Twilio has built-in features to detect when a machine picks up. You configure these settings in your VAPI Assistant so it knows when a voicemail system has answered instead of a live person.
15+
Twilio has built-in features to detect when a machine picks up. You configure these settings in your Vapi Assistant so it knows when a voicemail system has answered instead of a live person.
1616

1717
```jsx
1818
voicemailDetection: {
@@ -33,7 +33,7 @@ voicemailDetection: {
3333

3434
```
3535

36-
- **provider**: Tells VAPI to use Twilio’s system.
36+
- **provider**: Tells Vapi to use Twilio’s system.
3737
- **voicemailDetectionTypes**: Defines the events that mean “voicemail.”
3838
- **machineDetectionTimeout**: How many seconds to wait to confirm a machine.
3939
- The other settings let you fine-tune how quickly or accurately Twilio identifies a machine based on speech or silence.
@@ -49,7 +49,7 @@ voicemailDetection: {
4949

5050
### **2. Using VAPI’s Built-In Voicemail Tool**
5151

52-
VAPI also has an LLM-powered tool that listens for typical voicemail greetings or prompts in the call’s audio transcription. If you prefer an approach that relies more on phrasing and context clues, this is a great option.
52+
Vapi also has an LLM-powered tool that listens for typical voicemail greetings or prompts in the call’s audio transcription. If you prefer an approach that relies more on phrasing and context clues, this is a great option.
5353

5454
```jsx
5555
{
@@ -61,7 +61,7 @@ VAPI also has an LLM-powered tool that listens for typical voicemail greetings o
6161

6262
```
6363

64-
Here, `tools: [{ type: "voicemail" }]` signals that your VAPI Assistant should look for keywords or patterns indicating a voicemail greeting.
64+
Here, `tools: [{ type: "voicemail" }]` signals that your Vapi Assistant should look for keywords or patterns indicating a voicemail greeting.
6565

6666
## **Combining Both Approaches**
6767

@@ -124,7 +124,7 @@ When one method doesn’t catch it, the other might—boosting your overall dete
124124

125125
## **Testing and Next Steps**
126126

127-
1. **Make a Test Call**: Dial a known voicemail number and watch how quickly (and accurately) your VAPI Assistant identifies the machine.
127+
1. **Make a Test Call**: Dial a known voicemail number and watch how quickly (and accurately) your Vapi Assistant identifies the machine.
128128
2. **Tweak Settings**: Adjust your timeout and threshold values based on real-world performance.
129129
3. **Repeat**: Keep testing until you’re confident your configuration is catching voicemail reliably without cutting off real people.
130130

fern/changelog/2024-10-09.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
1. **Call Cost Information**: You can now use `call.costs[type=vapi].subType` to determine if a VAPI cost is `normal` or an `overage`.
1+
1. **Call Cost Information**: You can now use `call.costs[type=vapi].subType` to determine if a Vapi cost is `normal` or an `overage`.
22

33
2. **Updated Billing Page**: Your payments are now returned inside a table with pages on the [billing page](https://dashboard.vapi.ai/org/billing).

fern/community/expert-directory.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ Whether you need help deciding what to automate or assistance in building it, Va
262262
<div className="card-content">
263263
<h3>Flowzen</h3>
264264
<p>
265-
Our agency offers Voice AI solutions using VAPI, in English and Spanish,
265+
Our agency offers Voice AI solutions using Vapi, in English and Spanish,
266266
integrated with platforms like GoHighLevel, Airtable, and Make.com.
267267
</p>
268268
</div>
@@ -422,7 +422,7 @@ Whether you need help deciding what to automate or assistance in building it, Va
422422
/>
423423
<div className="card-content">
424424
<h3>NukyLabs.AI</h3>
425-
<p>All Services for VAPI.ai Automation </p>
425+
<p>All Services for Vapi.ai Automation </p>
426426
</div>
427427
</Card>
428428

@@ -541,7 +541,7 @@ Whether you need help deciding what to automate or assistance in building it, Va
541541
<h3>Value Added Tech</h3>
542542
<p>
543543
Top-notch automation company. We specialise in Make.com (Silver partner),
544-
multiple CRMs and VAPI.
544+
multiple CRMs and Vapi.
545545
</p>
546546
</div>
547547
</Card>

fern/community/myvapi.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ slug: community/myvapi
44
---
55

66

7-
Here is the updated MyVapi User Guide, including the customer endpoints and noting that MyVapi uses 27 out of the 33 available VAPI APIs:
7+
Here is the updated MyVapi User Guide, including the customer endpoints and noting that MyVapi uses 27 out of the 33 available Vapi APIs:
88
# MyVapi User Guide
99

1010
Welcome to MyVapi! This guide will help you get started with using MyVapi, your custom GPT, to enhance your productivity and streamline your tasks. Follow the steps below to make the most out of this powerful tool.
@@ -22,7 +22,7 @@ Welcome to MyVapi! This guide will help you get started with using MyVapi, your
2222
## Introduction to MyVapi
2323

2424
### What is MyVapi?
25-
MyVapi is a custom GPT designed to allow users to manage their Vapi accounts with ease. While the Vapi Dashboard provides limited functionality and using PostMan can be cumbersome, MyVapi offers a streamlined solution to interact with the Vapi API directly. This eliminates the back-and-forth usually associated with manual API interactions and JSON validation, making the process more efficient and user-friendly. The reason MyVapi was created is to help users understand the power of using VAPI's API. MyVapi uses 27 out of the 33 available VAPI APIs.
25+
MyVapi is a custom GPT designed to allow users to manage their Vapi accounts with ease. While the Vapi Dashboard provides limited functionality and using PostMan can be cumbersome, MyVapi offers a streamlined solution to interact with the Vapi API directly. This eliminates the back-and-forth usually associated with manual API interactions and JSON validation, making the process more efficient and user-friendly. The reason MyVapi was created is to help users understand the power of using Vapi's API. MyVapi uses 27 out of the 33 available Vapi APIs.
2626

2727
### Key Features
2828
- **Full API Access:** Leverage the full power of the Vapi API without the limitations of the Dashboard.

fern/customization/custom-keywords.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: customization/custom-keywords
55
---
66

77

8-
VAPI allows you to improve the accuracy of your transcriptions by leveraging Deepgram's keyword boosting feature. This is particularly useful when dealing with specialized terminology or uncommon proper nouns. By providing specific keywords to the Deepgram model, you can enhance transcription quality directly through VAPI.
8+
Vapi allows you to improve the accuracy of your transcriptions by leveraging Deepgram's keyword boosting feature. This is particularly useful when dealing with specialized terminology or uncommon proper nouns. By providing specific keywords to the Deepgram model, you can enhance transcription quality directly through Vapi.
99

1010
### Why Use Keyword Boosting?
1111

@@ -21,15 +21,15 @@ Keyword boosting is beneficial for:
2121
- Custom model training is the most effective way to ensure accurate keyword recognition.
2222
- For more than 50 keywords, consider custom model training by contacting Deepgram.
2323

24-
## Enabling Keyword Boosting in VAPI
24+
## Enabling Keyword Boosting in Vapi
2525

2626
### API Call Integration
2727

28-
To enable keyword boosting, you need to add a `keywords` parameter to your VAPI assistant's transcriber section. This parameter should include the keywords and their respective intensifiers.
28+
To enable keyword boosting, you need to add a `keywords` parameter to your Vapi assistant's transcriber section. This parameter should include the keywords and their respective intensifiers.
2929

3030
### Example of POST Request
3131

32-
To create an assistant with keyword boosting enabled, you can make the following POST request to VAPI:
32+
To create an assistant with keyword boosting enabled, you can make the following POST request to Vapi:
3333

3434
```bash
3535
bashCopy code
@@ -92,4 +92,4 @@ Intensifiers are exponential factors that boost or suppress the likelihood of th
9292

9393
For more detailed information on Deepgram's keyword boosting feature, refer to the Deepgram Keyword Boosting Documentation.
9494

95-
By following these guidelines, you can effectively utilize Deepgram's keyword boosting feature within your VAPI assistant, ensuring enhanced transcription accuracy for specialized terminology and uncommon proper nouns.
95+
By following these guidelines, you can effectively utilize Deepgram's keyword boosting feature within your Vapi assistant, ensuring enhanced transcription accuracy for specialized terminology and uncommon proper nouns.

fern/customization/custom-voices/elevenlabs.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ slug: customization/custom-voices/elevenlabs
55
---
66

77

8-
This guide outlines the procedure for integrating your cloned voice with 11labs through the VAPI platform.
8+
This guide outlines the procedure for integrating your cloned voice with 11labs through the Vapi platform.
99

1010
<Note>An subscription is required for this process to work.</Note>
1111

12-
To integrate your cloned voice with 11labs using the VAPI platform, follow these steps.
12+
To integrate your cloned voice with 11labs using the Vapi platform, follow these steps.
1313

1414
1. **Obtain an 11labs API Subscription:** Visit the [11labs pricing page](https://elevenlabs.io/pricing) and subscribe to an API plan that suits your needs.
1515
2. **Retrieve Your API Key:** Go to the 'Profile + Keys' section on the 11labs website to get your API key.
16-
3. **Enter Your API Key in VAPI:** Navigate to the [VAPI Provider Key section](https://dashboard.vapi.ai/keys) and input your 11labs API key under the 11labs section.
17-
4. **Sync Your Cloned Voice:** From the [Voice Library](https://dashboard.vapi.ai/voice-library) in VAPI, select 11labs as your voice provider and click on "Sync with 11labs."
16+
3. **Enter Your API Key in Vapi:** Navigate to the [Vapi Provider Key section](https://dashboard.vapi.ai/keys) and input your 11labs API key under the 11labs section.
17+
4. **Sync Your Cloned Voice:** From the [Voice Library](https://dashboard.vapi.ai/voice-library) in Vapi, select 11labs as your voice provider and click on "Sync with 11labs."
1818
5. **Search and Use Your Cloned Voice:** After syncing, you can search for your cloned voice within the voice library and directly use it with your assistant.
1919

20-
By following these steps, you will successfully integrate your cloned voice from 11labs with VAPI.
20+
By following these steps, you will successfully integrate your cloned voice from 11labs with Vapi.
2121

2222
**Video Tutorial:**
2323
<iframe

fern/customization/custom-voices/playht.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ slug: customization/custom-voices/playht
55
---
66

77

8-
This guide outlines the procedure for integrating your cloned voice with Play.ht through the VAPI platform.
8+
This guide outlines the procedure for integrating your cloned voice with Play.ht through the Vapi platform.
99

1010
<Note>An API subscription is required for this process to work.</Note>
1111

12-
To integrate your cloned voice with [Play.ht](http://play.ht/) using the VAPI platform, follow these steps.
12+
To integrate your cloned voice with [Play.ht](http://play.ht/) using the Vapi platform, follow these steps.
1313

1414
1. **Obtain a Play.ht API Subscription:** Visit the [Play.ht pricing page](https://play.ht/studio/pricing) and subscribe to an API plan.
1515
2. **Retrieve Your User ID and Secret Key:** Go to the [API Access section](https://play.ht/studio/api-access) on Play.ht to get your User ID and Secret Key.
16-
3. **Enter Your API Keys in VAPI:** Navigate to the [VAPI Provider Key section](https://dashboard.vapi.ai/keys) and input your Play.ht API keys under the Play.ht section.
17-
4. **Sync Your Cloned Voice:** From the [Voice Library](https://dashboard.vapi.ai/voice-library) in VAPI, select Play.ht as your voice provider and click on "Sync with Play.ht."
16+
3. **Enter Your API Keys in Vapi:** Navigate to the [Vapi Provider Key section](https://dashboard.vapi.ai/keys) and input your Play.ht API keys under the Play.ht section.
17+
4. **Sync Your Cloned Voice:** From the [Voice Library](https://dashboard.vapi.ai/voice-library) in Vapi, select Play.ht as your voice provider and click on "Sync with Play.ht."
1818
5. **Search and Use Your Cloned Voice:** After syncing, you can search for your cloned voice within the voice library and directly use it with your assistant.
1919

2020
**Video Tutorial:**

0 commit comments

Comments
 (0)