Skip to content

Commit 6afbaea

Browse files
committed
fix: broken links, use relative paths
1 parent 06a792a commit 6afbaea

File tree

11 files changed

+56
-53
lines changed

11 files changed

+56
-53
lines changed

fern/advanced/sip/sip-plivo.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,11 +150,11 @@ Indian phone numbers cannot be used with Plivo on Vapi due to TRAI regulations.
150150
```
151151
</Step>
152152
<Step title="Create a Vapi Assistant">
153-
1. [Follow this guide to create an assistant](https://docs.vapi.ai/quickstart/phone#create-your-first-voice-assistant)
153+
1. [Follow this guide to create an assistant](/quickstart/phone#create-your-first-voice-assistant)
154154
2. Note your Assistant ID for making calls.
155155
</Step>
156156
<Step title="Make Outbound Calls">
157-
[**Using the API**](https://docs.vapi.ai/calls/outbound-calling)
157+
[**Using the API**](/calls/outbound-calling)
158158

159159
```bash
160160
curl --location 'https://api.vapi.ai/call/phone' \
@@ -170,7 +170,7 @@ Indian phone numbers cannot be used with Plivo on Vapi due to TRAI regulations.
170170
}'
171171
```
172172

173-
[**Using the Vapi Dashboard**](https://docs.vapi.ai/quickstart/phone/outbound)
173+
[**Using the Vapi Dashboard**](/quickstart/phone#try-outbound-calling)
174174

175175
1. Select your Assistant
176176
2. Enter the phone number of the user you want to call

fern/advanced/sip/sip-twilio.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ This guide walks you through setting up both outbound and inbound SIP trunking b
144144

145145
1. **Create and Configure a Vapi Assistant**
146146

147-
- Create an assistant following the steps at [https://docs.vapi.ai/quickstart/phone#create-your-first-voice-assistant](https://docs.vapi.ai/quickstart/phone#create-your-first-voice-assistant)
147+
- Create an assistant following the steps in our [Phone Quickstart](/quickstart/phone#create-your-first-voice-assistant)
148148
- In the assistant settings, link it to the phone number you created
149149

150150
Now when someone calls your Twilio number, the call will be routed to your Vapi assistant.

fern/assistants/assistant-hooks.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Hooks are defined in the `hooks` array of your assistant configuration. Each hoo
2525
- `filters`: (Optional) Conditions that must be met for the hook to trigger
2626

2727
<Note>
28-
The `call.endedReason` filter can be set to any of the [call ended reasons](https://docs.vapi.ai/api-reference/calls/get#response.body.endedReason).
29-
The transfer destination type follows the [transfer call tool destinations](https://docs.vapi.ai/api-reference/tools/create#request.body.transferCall.destinations) schema.
28+
The `call.endedReason` filter can be set to any of the [call ended reasons](/api-reference/calls/get#response.body.endedReason).
29+
The transfer destination type follows the [transfer call tool destinations](/api-reference/tools/create#request.body.transferCall.destinations) schema.
3030
</Note>
3131

3232
## Example: Transfer on pipeline error
@@ -256,4 +256,4 @@ Add this hook configuration to your assistant to trigger Slack notifications on
256256

257257
<Note>
258258
Replace `<your-slack-webhook-url>` with your actual Slack webhook URL and `<your-serverless-function-url>` with your serverless function endpoint.
259-
</Note>
259+
</Note>

fern/assistants/call-recording.mdx

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,45 @@ slug: call-recording
66

77
The Call Recording feature allows you to capture and store full recordings of phone calls for analysis. By default, Vapi stores a complete recording of every call, providing both mono and stereo audio. The stereo option separates human and assistant audio into two distinct channels, offering a clearer analysis of the conversation.
88

9-
You can customize this behavior in the assistant's [`assistant.artifactPlan`](https://docs.vapi.ai/api-reference/assistants/create#request.body.artifactPlan).
9+
You can customize this behavior in the assistant's [`assistant.artifactPlan`](/api-reference/assistants/create#request.body.artifactPlan).
1010

11+
## Recording Formats
1112

12-
## Supported Formats
13+
Vapi supports multiple recording formats to fit your storage and playback needs.
1314

14-
Vapi supports multiple audio formats for call recordings:
15-
- `wav;l16`: 16-bit linear PCM WAV format, providing high-quality uncompressed audio in mono
16-
- `mp3`: MP3 compressed audio format, offering good quality with smaller file sizes
15+
You can specify your preferred format using the [`assistant.artifactPlan.recordingFormat`](/api-reference/assistants/create#request.body.artifactPlan.recordingFormat) property. If not specified, recordings will default to `wav;l16`.
1716

18-
You can specify your preferred format using the [`assistant.artifactPlan.recordingFormat`](https://docs.vapi.ai/api-reference/assistants/create#request.body.artifactPlan.recordingFormat) property. If not specified, recordings will default to `wav;l16`.
17+
**Supported formats:**
18+
- `wav;l16` (default) - High quality linear PCM
19+
- `mp3` - Compressed format for smaller file sizes
20+
- `flac` - Lossless compression for archival
1921

20-
<Note>
21-
At this time, you can only specify one format.
22-
</Note>
22+
## Storage Options
2323

24-
## Custom Storage bucket
24+
Vapi supports uploading recordings to your own storage buckets. See [Integrations -> Cloud](/providers/cloud/s3) for more information on available storage options.
2525

26-
Vapi supports uploading recordings to your own storage buckets. See [Integrations -> Cloud](https://docs.vapi.ai/providers/cloud/s3) for more information on available storage options.
26+
**Supported cloud storage providers:**
27+
- AWS S3
28+
- Google Cloud Storage
29+
- Cloudflare R2
30+
- Supabase
2731

28-
## Upload Path
32+
## Configuration Options
2933

30-
When uploading recordings to your custom storage bucket, you can specify the upload path using the `assistant.artifactPlan.recordingPath` property. If not specified, recordings will default to the root of the bucket.
34+
### Enable/Disable Recording
3135

32-
Usage:
33-
- If you want to upload the recording to a specific path, set this to the path. Example: `/my-assistant-recordings`.
34-
- If you want to upload the recording to the root of the bucket, set this to `/`.
36+
You can turn on/off call recording by setting the [`assistant.artifactPlan.recordingEnabled`](/api-reference/assistants/create#request.body.artifactPlan.recordingEnabled) property to `true` or `false`. If not specified, recordings will default to `true`.
3537

36-
## Turn On/Off Call Recording
38+
**HIPAA Compliance:** If [HIPAA](/security-and-privacy/hipaa) mode is enabled, Vapi will only store recordings if you have defined a custom storage bucket. Make sure to set credentials in the Provider Credentials section of your dashboard.
3739

38-
You can turn on/off call recording by setting the [`assistant.artifactPlan.recordingEnabled`](https://docs.vapi.ai/api-reference/assistants/create#request.body.artifactPlan.recordingEnabled) property to `true` or `false`. If not specified, recordings will default to `true`.
40+
### Video Recording
3941

40-
<Note>
41-
If [HIPAA](https://docs.vapi.ai/security-and-privacy/hipaa) mode is enabled, Vapi will only store recordings if you have defined a custom storage bucket. Make sure to set credentials in the Provider Credentials page in the Dashboard.
42-
</Note>
42+
You can turn on/off video recording by setting the [`assistant.artifactPlan.videoRecordingEnabled`](/api-reference/assistants/create#request.body.artifactPlan.videoRecordingEnabled) property to `true` or `false`. If not specified, video recording will default to `false`.
4343

44-
## Turn On/Off Video Recording (only for webCall)
44+
## Upload Path
4545

46-
You can turn on/off video recording by setting the [`assistant.artifactPlan.videoRecordingEnabled`](https://docs.vapi.ai/api-reference/assistants/create#request.body.artifactPlan.videoRecordingEnabled) property to `true` or `false`. If not specified, video recording will default to `false`.
46+
When uploading recordings to your custom storage bucket, you can specify the upload path using the `assistant.artifactPlan.recordingPath` property. If not specified, recordings will default to the root of the bucket.
4747

48+
Usage:
49+
- If you want to upload the recording to a specific path, set this to the path. Example: `/my-assistant-recordings`.
50+
- If you want to upload the recording to the root of the bucket, set this to `/`.

fern/call-forwarding.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,4 +454,4 @@ Here is a full example of a `transferCall` payload using the experimental warm t
454454
**Notes:**
455455

456456
- In all warm transfer modes, the `{{transcript}}` variable contains the full transcript of the call and can be used within the `summaryPlan`.
457-
- For more details about transfer plans and configuration options, please refer to the [transferCall API documentation](https://docs.vapi.ai/api-reference/tools/create#request.body.transferCall.destinations.number.transferPlan)
457+
- For more details about transfer plans and configuration options, please refer to the [transferCall API documentation](/api-reference/tools/create#request.body.transferCall.destinations.number.transferPlan)

fern/calls/voicemail-detection.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ For each detection method, you can fine-tune the following parameters:
6262

6363
| Parameter | Description |
6464
| :-------- | :---------- |
65-
| **<a href="https://docs.vapi.ai/api-reference/assistants/create#request.body.voicemailDetection.vapi.backoffPlan.startAtSeconds" target="_blank">Initial Detection Delay</a>** | How long to wait (in seconds) before starting voicemail detection |
66-
| **<a href="https://docs.vapi.ai/api-reference/assistants/create#request.body.voicemailDetection.vapi.backoffPlan.frequencySeconds" target="_blank">Detection Retry Interval</a>** | How frequently to check for voicemail (in seconds) |
67-
| **<a href="https://docs.vapi.ai/api-reference/assistants/create#request.body.voicemailDetection.vapi.backoffPlan.maxRetries" target="_blank">Max Detection Retries</a>** | Maximum number of detection attempts before stopping |
68-
| **<a href="https://docs.vapi.ai/api-reference/assistants/create#request.body.voicemailDetection.vapi.beepMaxAwaitSeconds" target="_blank">Max Voicemail Message Wait</a>** | Maximum time to wait before leaving a message (even without beep detection) |
65+
| **<a href="/api-reference/assistants/create#request.body.voicemailDetection.vapi.backoffPlan.startAtSeconds" target="_blank">Initial Detection Delay</a>** | How long to wait (in seconds) before starting voicemail detection. |
66+
| **<a href="/api-reference/assistants/create#request.body.voicemailDetection.vapi.backoffPlan.frequencySeconds" target="_blank">Detection Retry Interval</a>** | How frequently to check for voicemail after the initial delay. |
67+
| **<a href="/api-reference/assistants/create#request.body.voicemailDetection.vapi.backoffPlan.maxRetries" target="_blank">Max Detection Retries</a>** | Maximum number of detection attempts before stopping. |
68+
| **<a href="/api-reference/assistants/create#request.body.voicemailDetection.vapi.beepMaxAwaitSeconds" target="_blank">Max Voicemail Message Wait</a>** | Maximum time to wait before leaving a voicemail if no beep is detected. |
6969

7070
These settings allow you to balance:
7171
- **Speed** (how quickly voicemail is detected)

fern/examples/docs-agent.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -219,22 +219,22 @@ You'll learn to:
219219
</Step>
220220

221221
<Step title="Improve your prompts with call analysis">
222-
Vapi automatically analyzes every call. The assistant above includes an [`analysisPlan`](https://docs.vapi.ai/api-reference/assistants/create#request.body.analysisPlan) with summary and success evaluation configured.
222+
Vapi automatically analyzes every call. The assistant above includes an [`analysisPlan`](/api-reference/assistants/create#request.body.analysisPlan) with summary and success evaluation configured.
223223

224224
Configure additional analysis options in your assistant:
225225
- **Summary plan**: Custom prompts for call summaries
226226
- **Structured data plan**: Extract specific information using JSON schemas
227227
- **Success evaluation plan**: Score calls with custom rubrics
228228
- **Structured data multi plan**: Multiple extraction schemas
229229

230-
Retrieve analysis results using the [Get Call API](https://docs.vapi.ai/api-reference/calls/get#response.body.analysis):
230+
Retrieve analysis results using the [Get Call API](/api-reference/calls/get#response.body.analysis):
231231

232232
```bash
233-
curl https://api.vapi.ai/call/CALL_ID \
233+
curl https://api.vapi.ai/call/{CALL_ID} \
234234
-H "Authorization: Bearer YOUR_VAPI_API_KEY"
235235
```
236236

237-
The response includes `call.analysis` with your configured analysis results. Learn more about [call analysis configuration](https://docs.vapi.ai/assistants/call-analysis).
237+
The response includes `call.analysis` with your configured analysis results. Learn more about [call analysis configuration](/assistants/call-analysis).
238238

239239
**Iterative improvements:**
240240
- Review analysis summaries to identify common user questions

fern/knowledge-base/integrating-with-trieve.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ Use Trieve's search playground to:
268268
1. Create your Trieve API key from [Trieve's dashboard](https://dashboard.trieve.ai/org/keys)
269269
2. Add your Trieve API key to Vapi [Provider Credentials](https://dashboard.vapi.ai/keys)
270270
![Add Trieve API key in Vapi](../static/images/knowledge-base/trieve-credential.png)
271-
3. Once your dataset is optimized in Trieve, import it to Vapi via POST request to the [create knowledge base route](https://docs.vapi.ai/api-reference/knowledge-bases/create):
271+
3. Once your dataset is optimized in Trieve, import it to Vapi via POST request to the [create knowledge base route](/api-reference/knowledge-bases/create):
272272

273273
```json
274274
{

fern/providers/observability/langfuse.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ You can enhance your observability in Langfuse by adding metadata and tags:
9292

9393
**Metadata**
9494

95-
Use the [`assistant.observabilityPlan.metadata`](https://docs.vapi.ai/api-reference/assistants/create#request.body.observabilityPlan.metadata) field to attach custom key-value pairs.
95+
Use the [`assistant.observabilityPlan.metadata`](/api-reference/assistants/create#request.body.observabilityPlan.metadata) field to attach custom key-value pairs.
9696

9797
Examples:
9898
- Track experiment versions ("experiment": "v2.1")
@@ -101,7 +101,7 @@ Examples:
101101

102102
**Tags**
103103

104-
Use the [`assistant.observabilityPlan.tags`](https://docs.vapi.ai/api-reference/assistants/create#request.body.observabilityPlan.tags) field to add searchable labels.
104+
Use the [`assistant.observabilityPlan.tags`](/api-reference/assistants/create#request.body.observabilityPlan.tags) field to add searchable labels.
105105

106106
Examples:
107107
- Mark important runs ("priority")
@@ -111,4 +111,4 @@ Examples:
111111
Adding metadata and tags makes it easier to filter, analyze, and monitor your assistants activity in Langfuse.
112112

113113
### Example
114-
![Langfuse Metadata Example](../../static/images/providers/langfuse-example.png)
114+
![Langfuse Metadata Example](../../static/images/providers/langfuse-example.png)

fern/snippets/quickstart/dashboard/assistant-setup-inbound.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Sign-up for an account (or log-in to your existing account) — you will then find yourself inside the web dashboard. It will look something like this:
1010

11-
<Frame caption="Your dashboard may look a bit different if you already have an account with assistants in it. The main idea is that were in the dashboard now.">
11+
<Frame caption="Your dashboard may look a bit different if you already have an account with assistants in it. The main idea is that we're in the dashboard now.">
1212
<img src="../static/images/quickstart/dashboard/vapi-dashboard-post-signup.png" />
1313
</Frame>
1414

@@ -30,7 +30,7 @@
3030
<img src="../static/images/quickstart/dashboard/choose-blank-template.png" />
3131
</Frame>
3232

33-
You will then be able to name your assistant — you can name it whatever you'd like (`Vapis Pizza Front Desk`, for example):
33+
You will then be able to name your assistant — you can name it whatever you'd like (`Vapi's Pizza Front Desk`, for example):
3434

3535
<Info>
3636
This name is only for internal labeling use. It is not an identifier, nor will the assistant be
@@ -43,26 +43,26 @@
4343

4444
Once you have named your assistant, you can hit "Create" to create it. You will then see something like this:
4545

46-
<Frame caption="The assistant overview. You can edit your assistants transcriber, model, & voice — and edit other advanced configuration.">
46+
<Frame caption="The assistant overview. You can edit your assistant's transcriber, model, & voice — and edit other advanced configuration.">
4747
<img src="../static/images/quickstart/dashboard/assistant-created.png" />
4848
</Frame>
4949

50-
This is the assistant overview view — it gives you the ability to edit different attributes about your assistant, as well as see **cost** & **latency** projection information for each portion of its voice pipeline (this is very important data to have handy when building out your assistants).
50+
This is the assistant overview view — it gives you the ability to edit different attributes about your assistant, as well as see **cost** & **latency** projection information for each portion of it's voice pipeline (this is very important data to have handy when building out your assistants).
5151

5252
</Accordion>
5353
<Accordion title="Model Setup" icon="microchip" iconType="solid">
54-
Now were going to set the "brains" of the assistant, the large language model. We're going to be using `GPT-4` (from [OpenAI](https://openai.com/)) for this demo (though you're free to use `GPT-3.5`, or any one of your favorite LLMs).
54+
Now we're going to set the "brains" of the assistant, the large language model. We're going to be using `GPT-4` (from [OpenAI](https://openai.com/)) for this demo (though you're free to use `GPT-3.5`, or any one of your favorite LLMs).
5555

5656
<AccordionGroup>
5757
<Accordion title="Set Your OpenAI Provider Key (optional)" icon="key" iconType="solid">
58-
Before we proceed, we can set our [provider key](https://docs.vapi.ai/customization/provider-keys) for OpenAI (this is just your OpenAI secret key).
58+
Before we proceed, we can set our [provider key](/customization/provider-keys) for OpenAI (this is just your OpenAI secret key).
5959

6060
<Note>
6161
You can see all of your provider keys in the "Provider Keys" dashboard tab. You can also go
6262
directly to [dashboard.vapi.ai/keys](https://dashboard.vapi.ai/keys).
6363
</Note>
6464

65-
Vapi uses [provider keys](https://docs.vapi.ai/customization/provider-keys) you provide to communicate with LLM, TTS, & STT vendors on your behalf. It is most ideal that we set keys for the vendors we intend to use ahead of time.
65+
Vapi uses [provider keys](/customization/provider-keys) you provide to communicate with LLM, TTS, & STT vendors on your behalf. It is most ideal that we set keys for the vendors we intend to use ahead of time.
6666

6767
<Frame caption="We set our provider key for OpenAI so Vapi can make requests to their API.">
6868
<img src="../static/images/quickstart/dashboard/model-provider-keys.png" />
@@ -85,7 +85,7 @@
8585
For our use case, we will want a first message. It would be ideal for us to have a first message like this:
8686

8787
```text
88-
Vappys Pizzeria speaking, how can I help you?
88+
Vappy's Pizzeria speaking, how can I help you?
8989
```
9090

9191
<Info>
@@ -105,7 +105,7 @@
105105
The system prompt can be used to configure the context, role, personality, instructions and so on for the assistant. In our case, a system prompt like this will give us the behavior we want:
106106

107107
```text
108-
You are a voice assistant for Vappys Pizzeria,
108+
You are a voice assistant for Vappy's Pizzeria,
109109
a pizza shop located on the Internet.
110110
111111
Your job is to take the order of customers calling in. The menu has only 3 types

0 commit comments

Comments
 (0)