Skip to content

docs: add transcriptType and turnId fields to WebSocket message docs#978

Open
dhruva-reddy wants to merge 1 commit intomainfrom
dr/update-transcript-type
Open

docs: add transcriptType and turnId fields to WebSocket message docs#978
dhruva-reddy wants to merge 1 commit intomainfrom
dr/update-transcript-type

Conversation

@dhruva-reddy
Copy link

@dhruva-reddy dhruva-reddy commented Mar 16, 2026

Description

  • Updates fern/customization/custom-transcriber.mdx to document the new optional transcriptType field ("partial" | "final") on transcriber-response messages, enabling custom STT servers to send progressive transcription updates (from VapiAI/vapi#10548)
  • Adds transcriptType: "final" to all JSON examples and the server.js code example in the custom transcriber guide
  • Adds a "Partial transcripts" entry to the Notes and limitations section explaining replacement-style partial behavior and backward compatibility
  • Updates fern/server-url/events.mdx to document the new optional turnId field on model-output messages (groups tokens from the same LLM response) and user-interrupted messages (identifies the interrupted turn for token discarding)

Testing Steps

  • Run fern check -- passes with 0 errors
  • Verify JSON examples are valid (all new/modified JSON blocks parse correctly)
  • Verify internal links resolve to existing pages (no new broken links introduced)
  • Confirm changed pages render correctly in the preview deployment
  • Review page content for style guide compliance (active voice, present tense, consistent terminology)
  • Cross-check API field documentation against source PR VapiAI/vapi#10548

Document three new optional fields from VapiAI/vapi#10548:
- transcriptType (partial|final) on transcriber-response messages
- turnId on model-output and user-interrupted messages

Made-with: Cursor
@github-actions
Copy link
Contributor

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