From 247f5afe0473fb189cc4b8d96ed96d3a3d3d283d Mon Sep 17 00:00:00 2001 From: stevenbdf Date: Wed, 26 Mar 2025 15:24:21 -0700 Subject: [PATCH 1/3] feat: add call recording page --- fern/assistants/call-recording.mdx | 47 ++++++++++++++++++++++++++++++ fern/docs.yml | 2 ++ 2 files changed, 49 insertions(+) create mode 100644 fern/assistants/call-recording.mdx diff --git a/fern/assistants/call-recording.mdx b/fern/assistants/call-recording.mdx new file mode 100644 index 000000000..8ddf76348 --- /dev/null +++ b/fern/assistants/call-recording.mdx @@ -0,0 +1,47 @@ +--- +title: Call Recording +subtitle: Record calls and store them in Vapi or your own storage. +slug: call-recording +--- + +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. + +You can customize this behavior in the assistant's `assistant.artifactPlan`. + + +## Supported Formats + +Vapi supports multiple audio formats for call recordings: +- `wav;l16`: 16-bit linear PCM WAV format, providing high-quality uncompressed audio in mono +- `mp3`: MP3 compressed audio format, offering good quality with smaller file sizes + +You can specify your preferred format using the `assistant.artifactPlan.recordingFormat` property. If not specified, recordings will default to `wav;l16`. + + +At this time, you can only specify one format. + + +## Custom Storage bucket + +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. + +## Upload Path + +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. + +Usage: +- If you want to upload the recording to a specific path, set this to the path. Example: `/my-assistant-recordings`. +- If you want to upload the recording to the root of the bucket, set this to `/`. + +## Turn On/Off Call Recording + +You can turn on/off call recording by setting the `assistant.artifactPlan.recordingEnabled` property to `true` or `false`. If not specified, recordings will default to `true`. + + +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. + + +## Turn On/Off Video Recording (only for webCall) + +You can turn on/off video recording by setting the `assistant.artifactPlan.videoRecordingEnabled` property to `true` or `false`. If not specified, video recording will default to `false`. + diff --git a/fern/docs.yml b/fern/docs.yml index 2d4df5bdc..9a1605522 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -138,6 +138,8 @@ navigation: path: assistants/dynamic-variables.mdx - page: Call Analysis path: assistants/call-analysis.mdx + - page: Call Recording + path: assistants/call-recording.mdx - page: Assistant Hooks path: assistants/assistant-hooks.mdx - page: Background Messages From 3b2036c41b1b06b2f42313fc460d35e601e86035 Mon Sep 17 00:00:00 2001 From: stevenbdf Date: Wed, 26 Mar 2025 15:42:04 -0700 Subject: [PATCH 2/3] feat: add links to api reference --- fern/assistants/call-recording.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/fern/assistants/call-recording.mdx b/fern/assistants/call-recording.mdx index 8ddf76348..862433857 100644 --- a/fern/assistants/call-recording.mdx +++ b/fern/assistants/call-recording.mdx @@ -6,7 +6,7 @@ slug: call-recording 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. -You can customize this behavior in the assistant's `assistant.artifactPlan`. +You can customize this behavior in the assistant's [`assistant.artifactPlan`](https://docs.vapi.ai/api-reference/assistants/create#request.body.artifactPlan). ## Supported Formats @@ -15,7 +15,7 @@ Vapi supports multiple audio formats for call recordings: - `wav;l16`: 16-bit linear PCM WAV format, providing high-quality uncompressed audio in mono - `mp3`: MP3 compressed audio format, offering good quality with smaller file sizes -You can specify your preferred format using the `assistant.artifactPlan.recordingFormat` property. If not specified, recordings will default to `wav;l16`. +You can specify your preferred format using the [`assistant.artifactPlan.recordingFormat`](https://docs.vapi.ai/api-reference/assistants/create#request.body.artifactPlan) property. If not specified, recordings will default to `wav;l16`. At this time, you can only specify one format. @@ -35,7 +35,7 @@ Usage: ## Turn On/Off Call Recording -You can turn on/off call recording by setting the `assistant.artifactPlan.recordingEnabled` property to `true` or `false`. If not specified, recordings will default to `true`. +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`. 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. @@ -43,5 +43,5 @@ If [HIPAA](https://docs.vapi.ai/security-and-privacy/hipaa) mode is enabled, Vap ## Turn On/Off Video Recording (only for webCall) -You can turn on/off video recording by setting the `assistant.artifactPlan.videoRecordingEnabled` property to `true` or `false`. If not specified, video recording will default to `false`. +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`. From be8a0b83f764a9848b3bb1c5f6b3a8fe6e18e2c4 Mon Sep 17 00:00:00 2001 From: stevenbdf Date: Wed, 26 Mar 2025 18:03:22 -0700 Subject: [PATCH 3/3] feat: add recordingFormat link --- fern/assistants/call-recording.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/assistants/call-recording.mdx b/fern/assistants/call-recording.mdx index 862433857..422324420 100644 --- a/fern/assistants/call-recording.mdx +++ b/fern/assistants/call-recording.mdx @@ -15,7 +15,7 @@ Vapi supports multiple audio formats for call recordings: - `wav;l16`: 16-bit linear PCM WAV format, providing high-quality uncompressed audio in mono - `mp3`: MP3 compressed audio format, offering good quality with smaller file sizes -You can specify your preferred format using the [`assistant.artifactPlan.recordingFormat`](https://docs.vapi.ai/api-reference/assistants/create#request.body.artifactPlan) property. If not specified, recordings will default to `wav;l16`. +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`. At this time, you can only specify one format.