Skip to content

Voice Agent API Docs Updates#230

Open
LArmstrongDev wants to merge 8 commits intomainfrom
preview-voice-agent-api-update
Open

Voice Agent API Docs Updates#230
LArmstrongDev wants to merge 8 commits intomainfrom
preview-voice-agent-api-update

Conversation

@LArmstrongDev
Copy link
Contributor

@LArmstrongDev LArmstrongDev commented Mar 19, 2026

This MR includes improvements to the Preview docs for the Voice Agent API. These changes are necessary for bringing the docs up to standard, providing the complete information needed for testing, and API spec details.

Changes include:

  • Complete restructure of the document to make information easier to
  • Adding link to Speechmatics Academy into the introduction for easy signposting to code examples,
  • Added Session Flow section and diagram
  • Fix naming (including temporary update to SmartTurnResult to match current API behaviour)
  • Create sections for "Client -> Server" and "Server -> Client" API spec.
  • Add complete coverage for all Voice Agent API messages
  • Polish of grammar and formatting

@vercel
Copy link

vercel bot commented Mar 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 25, 2026 2:46pm

Request Review

@LArmstrongDev
Copy link
Contributor Author

Todo - add clarity on supported languages.

Clarifies that only pcm_s16le at 8000/16000 Hz is supported. Other
formats may be silently accepted but will not produce correct output.
- Add real payloads and field descriptions for EndOfTurnPrediction,
  SmartTurnResult, SpeechStarted and SpeechEnded
- Rename SmartTurnPrediction to SmartTurnResult throughout (mermaid
  diagram, messages table, section header)
- Add audio format warning and example to audio_format section
The payload is already documented in the SpeakersResult server message
section. Replace with links to the API reference entries for GetSpeakers
and SpeakersResult.
…ocks

- Fix ordering: SpeakerStarted after StartOfTurn, SpeechEnded/EndOfUtterance/
  SpeakerEnded before AddSegment, EndOfTurn last
- Add missing EndOfUtterance
- Remove incorrect Speaker activity opt block — speaker events now in correct
  position in the main flow
- Add profile annotations inline (adaptive/smart, smart only, external only)
- Move ForceEndOfUtterance into mid-session controls opt block
- Add SessionMetrics note below diagram
Move language info out of Trade-off text into a dedicated Languages field,
consistent with Best for / Trade-off pattern. All profiles now explicitly
state language support.
@LArmstrongDev
Copy link
Contributor Author

The additional changes all LGTM - and ticks off all the outstanding todos. Thanks for picking those up, @ArchieMcM234!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants