docs(web): document assistant.speechStarted live caption usage#1030
Merged
dhruva-reddy merged 1 commit intomainfrom Apr 22, 2026
Merged
docs(web): document assistant.speechStarted live caption usage#1030dhruva-reddy merged 1 commit intomainfrom
dhruva-reddy merged 1 commit intomainfrom
Conversation
Contributor
Author
This was referenced Apr 22, 2026
Contributor
|
🌿 Preview your docs: https://vapi-preview-d7fc1299-5e78-4b2d-9c9c-6cb8d7a64ac0.docs.buildwithfern.com |
dhruva-reddy
force-pushed
the
dr/docs-sdk-web-assistant-speech-started
branch
from
e254dd0 to
e55a4f5
Compare
dhruva-reddy
changed the title
4 tasks
Contributor
|
🌿 Preview your docs: https://vapi-preview-cea3e88f-0582-48fd-b206-8813c31dba01.docs.buildwithfern.com |
adhamvapi
approved these changes
Apr 22, 2026
stevenbdf
approved these changes
Apr 22, 2026
dhruva-reddy
force-pushed
the
dr/docs-providers-minimax
branch
from
5470773 to
e91e0fc
Compare
dhruva-reddy
force-pushed
the
dr/docs-sdk-web-assistant-speech-started
branch
from
e55a4f5 to
5205875
Compare
dhruva-reddy
changed the base branch from
dr/docs-providers-minimax
to
graphite-base/1030
dhruva-reddy
force-pushed
the
graphite-base/1030
branch
from
e91e0fc to
cbe4c3c
Compare
dhruva-reddy
force-pushed
the
dr/docs-sdk-web-assistant-speech-started
branch
from
5205875 to
5b679b5
Compare
Contributor
Author
Merge activity
|
Contributor
|
🌿 Preview your docs: https://vapi-preview-f1810dde-5547-43d7-bcf3-b19926dcb39d.docs.buildwithfern.com |
Contributor
|
🌿 Preview your docs: https://vapi-preview-f146c97c-2d35-4621-bbc1-5e09d5e64ee8.docs.buildwithfern.com |
Contributor
|
🌿 Preview your docs: https://vapi-preview-b678cea0-c83d-4850-a125-5d639786fcea.docs.buildwithfern.com |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
### Live captions and word-level timingsection tofern/quickstart/web.mdx, slotted between the Web SDK installation tabs and### Voice widget implementationso it's discoverable in the natural client-side flow.fern/sdk/web.mdx, but that page is redirected away (/sdk/web → /quickstart/webperdocs.ymlline 1058) and is effectively orphaned. Moved the content to the canonical destination so customers can actually find it.clientMessagesand consume the event in avapi.on("message", ...)handler with concrete code that branches ontiming?.type.<Warning>callout explaining the cadence/granularity differences between providers so customers don't pick the wrong one for their UI:word-alignment) — true per-word playback cadenceword-progress) — segment-sized jumps near segment endforce-sayalways emits text-only and that barge-in stops emission for the interrupted turn.Testing Steps
/sdk/webredirects to/quickstart/webperdocs.ymlredirect rule, confirming the original target page was not user-reachable<Warning>block uses the same component pattern as existing warnings on this page