Commit aecebff
authored
docs(server-events): document assistant.speechStarted message (#1028)
## Description
- Adds a new `### Assistant Speech Started` section to `server-url/events.mdx` documenting the opt-in `assistant.speechStarted` server/client message
- Documents the full payload (`text`, `turn`, `source`, optional `timing`) and the three `timing` shapes:
- `word-alignment` (ElevenLabs) — per-word timestamps at playback cadence
- `word-progress` (Minimax with `voice.subtitleType: "word"`) — cursor-based per-segment progress
- absent — text-only fallback for all other providers
- Calls out the real limitations honestly so customers can choose the right provider for their use case:
- Minimax events fire near the _end_ of each synthesis segment (subtitle data only attaches to the final audio chunk per segment), not per-word in real time
- `force-say` events always emit text-only, even on ElevenLabs/Minimax
- No companion `assistant.speechStopped` event — use `speech-update` (`status: "stopped"`) or watch `turn` increment
- Barge-in stops emission for the interrupted turn — pair with `user-interrupted`
- `totalWords: 0` is a valid sentinel; guard against divide-by-zero
- This is the canonical schema page for the event. Two follow-up PRs in this stack ([Minimax provider page](https://app.graphite.com/github/pr/VapiAI/docs/1029), [Web SDK live captions section](https://app.graphite.com/github/pr/VapiAI/docs/1030)) deep-link into the `#assistant-speech-started` anchor created here.
## Testing Steps
- [x] Verified MDX renders by inspecting the source — no broken code fences, all `<Warning>` and table syntax matches existing usage on the page
- [x] Anchor `#assistant-speech-started` will be auto-generated by Fern from the `### Assistant Speech Started` heading; cross-references in PR 2 and PR 3 use this anchor
- [x] Reviewer: spot-check the Fern preview build for this PR1 parent 7dc5137 commit aecebff
1 file changed
Lines changed: 75 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
287 | 287 | | |
288 | 288 | | |
289 | 289 | | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
| 341 | + | |
| 342 | + | |
| 343 | + | |
| 344 | + | |
| 345 | + | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
290 | 365 | | |
291 | 366 | | |
292 | 367 | | |
| |||
0 commit comments