VAP-5098: add call recording page

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`](https://docs.vapi.ai/api-reference/assistants/create#request.body.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`](https://docs.vapi.ai/api-reference/assistants/create#request.body.artifactPlan.recordingFormat) property. If not specified, recordings will default to `wav;l16`.
+
+<Note>
+At this time, you can only specify one format.
+</Note>
+
+## 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`](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`.
+
+<Note>
+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.
+</Note>
+
+## Turn On/Off Video Recording (only for webCall)
+
+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`.
+

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