You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/advanced/sip/sip-twilio.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -144,7 +144,7 @@ This guide walks you through setting up both outbound and inbound SIP trunking b
144
144
145
145
1.**Create and Configure a Vapi Assistant**
146
146
147
-
- Create an assistant following the steps at [https://docs.vapi.ai/quickstart/dashboard#create-an-assistant](https://docs.vapi.ai/quickstart/dashboard#create-an-assistant)
147
+
- Create an assistant following the steps in our [Phone Quickstart](/quickstart/phone#create-your-first-voice-assistant)
148
148
- In the assistant settings, link it to the phone number you created
149
149
150
150
Now when someone calls your Twilio number, the call will be routed to your Vapi assistant.
Copy file name to clipboardExpand all lines: fern/assistants/assistant-hooks.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,8 +25,8 @@ Hooks are defined in the `hooks` array of your assistant configuration. Each hoo
25
25
-`filters`: (Optional) Conditions that must be met for the hook to trigger
26
26
27
27
<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.
30
30
</Note>
31
31
32
32
## Example: Transfer on pipeline error
@@ -256,4 +256,4 @@ Add this hook configuration to your assistant to trigger Slack notifications on
256
256
257
257
<Note>
258
258
Replace `<your-slack-webhook-url>` with your actual Slack webhook URL and `<your-serverless-function-url>` with your serverless function endpoint.
Copy file name to clipboardExpand all lines: fern/assistants/call-recording.mdx
+26-23Lines changed: 26 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,42 +6,45 @@ slug: call-recording
6
6
7
7
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.
8
8
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).
10
10
11
+
## Recording Formats
11
12
12
-
## Supported Formats
13
+
Vapi supports multiple recording formats to fit your storage and playback needs.
13
14
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`.
17
16
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
19
21
20
-
<Note>
21
-
At this time, you can only specify one format.
22
-
</Note>
22
+
## Storage Options
23
23
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.
25
25
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
27
31
28
-
## Upload Path
32
+
## Configuration Options
29
33
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
31
35
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`.
35
37
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.
37
39
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
39
41
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`.
43
43
44
-
## Turn On/Off Video Recording (only for webCall)
44
+
## Upload Path
45
45
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.
47
47
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 `/`.
Copy file name to clipboardExpand all lines: fern/call-forwarding.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -454,4 +454,4 @@ Here is a full example of a `transferCall` payload using the experimental warm t
454
454
**Notes:**
455
455
456
456
- 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)
Copy file name to clipboardExpand all lines: fern/calls/voicemail-detection.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,10 +62,10 @@ For each detection method, you can fine-tune the following parameters:
62
62
63
63
| Parameter | Description |
64
64
| :-------- | :---------- |
65
-
|**<ahref="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
-
|**<ahref="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
-
|**<ahref="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
-
|**<ahref="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
+
|**<ahref="/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
+
|**<ahref="/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
+
|**<ahref="/api-reference/assistants/create#request.body.voicemailDetection.vapi.backoffPlan.maxRetries"target="_blank">Max Detection Retries</a>**| Maximum number of detection attempts before stopping.|
68
+
|**<ahref="/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.|
Copy file name to clipboardExpand all lines: fern/examples/docs-agent.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -219,22 +219,22 @@ You'll learn to:
219
219
</Step>
220
220
221
221
<Steptitle="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.
223
223
224
224
Configure additional analysis options in your assistant:
225
225
- **Summary plan**: Custom prompts for call summaries
226
226
- **Structured data plan**: Extract specific information using JSON schemas
227
227
- **Success evaluation plan**: Score calls with custom rubrics
228
228
- **Structured data multi plan**: Multiple extraction schemas
229
229
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):
231
231
232
232
```bash
233
-
curl https://api.vapi.ai/call/CALL_ID \
233
+
curl https://api.vapi.ai/call/{CALL_ID} \
234
234
-H "Authorization: Bearer YOUR_VAPI_API_KEY"
235
235
```
236
236
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).
238
238
239
239
**Iterative improvements:**
240
240
- Review analysis summaries to identify common user questions
Copy file name to clipboardExpand all lines: fern/knowledge-base/integrating-with-trieve.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -268,7 +268,7 @@ Use Trieve's search playground to:
268
268
1. Create your Trieve API key from [Trieve's dashboard](https://dashboard.trieve.ai/org/keys)
269
269
2. Add your Trieve API key to Vapi [Provider Credentials](https://dashboard.vapi.ai/keys)
270
270

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):
0 commit comments