Skip to content

docs: add inline assistant recording caveat and expand retention docs - #1163

Open
stephenvapiai wants to merge 1 commit into
VapiAI:mainfrom
stephenvapiai:helpcenter-update/call-recording-retention
Open

docs: add inline assistant recording caveat and expand retention docs#1163
stephenvapiai wants to merge 1 commit into
VapiAI:mainfrom
stephenvapiai:helpcenter-update/call-recording-retention

Conversation

@stephenvapiai

Copy link
Copy Markdown
Contributor

What this fixes

Two incomplete-content gaps in fern/assistants/call-recording.mdx identified from customer feedback (week of Aug 12-19, 2026).


Gap 1 - Inline assistant artifactPlan requirement

Why: 3+ distinct support tickets this week from customers whose recordings silently failed. Root cause: dashboard artifactPlan settings are ignored when an assistant is embedded inline in POST /call. The docs page had no mention of this distinction.

What changed:

  • Added a new section "Inline vs. Saved Assistants" with a Warning callout
  • Side-by-side JSON examples for saved assistant calls (uses dashboard settings), inline assistant calls (must include artifactPlan), and assistantOverrides per-call override pattern

Gap 2 - Retention limits and recovery

Why: 4+ distinct customers this week hit 400 Bad Request errors trying to access recordings older than their plan retention window, surprised because the current docs only mention the limit in a one-line table at the bottom.

What changed:

  • Split the retention table into separate columns for call recordings (14d) vs chat transcripts (30d)
  • Added the exact 400 error message customers see when they exceed the window
  • Documented that call metadata remains accessible indefinitely (only the audio URL is affected)
  • Added two concrete recovery paths: custom S3/GCS storage (recordings go directly to the customer bucket, bypassing Vapi retention) and Enterprise upgrade (configurable retention)

Customer evidence patterns seen this week:

  • "Your subscription plan only covers the last 14 days of call history. This call exceeds your retention window."
  • Multiple customers asking for bulk exports of recordings older than 30 days
  • One customer needing recordings back to January 2026 for compliance and quality review

No navigation changes

This is an edit to an existing page, no docs.yml changes needed.

Testing

  • Fern preview: open Assistants > Call Recording and verify both new sections render correctly
  • Confirm Warning component renders
  • Confirm Callout footer renders
  • Review JSON code blocks for syntax

Two recurring documentation gaps found in customer feedback (week of Aug 12–19 2026):

1. Inline/transient assistant artifactPlan requirement (3+ support tickets this week):
   - Dashboard artifactPlan settings are silently ignored for inline assistants
   - Added <Warning> callout, side-by-side code examples for saved vs inline calls,
     and assistantOverrides override pattern

2. Recording retention limits and recovery (4+ distinct customers hit 400 errors):
   - Split table into call recordings (14d) vs chat transcripts (30d)
   - Added exact 400 error message customers see
   - Documented what remains accessible after expiry (metadata stays)
   - Added two recovery paths: custom S3/GCS storage (bypasses retention entirely)
     and Enterprise upgrade for configurable retention
@stephenvapiai
stephenvapiai marked this pull request as ready for review August 20, 2026 00:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant