Get started
Start with the basics. Learn the shared create-session, stream, and complete pattern, then follow Ambient or Dictation streaming for your product.Audio Streaming Overview
Stream Ambient audio over WebSocket after you create a session.
Streaming Architecture
Learn how Ambient, Form filling, and Dictation session creation, WebSocket frames, and results fit together.
Stream Ambient Audio
Open the Ambient stream and send audio frames.
Dictation Streaming
Stream Dictation audio over WebSocket after you create a session.
Dictation Streaming Transcripts
Learn how partial and final transcription frames arrive during a Dictation stream.
Wire format and session lifecycle
Ambient and Dictation use the same streaming pattern, but each product has its own frames and completion steps. Use these guides when you implement the WebSocket client.Wire Format Overview
Learn about shared WebSocket JSON frame patterns for Ambient and Dictation streaming.
Ambient Wire Format
Ambient-specific frames, fields, and message examples.
Dictation Wire Format
Dictation-specific frames, fields, and message examples.
Complete a Streaming Session
End the stream cleanly and finish the session with REST.
Ambient Session Recordings
Stream or download Ambient session audio after the visit for listen-back or compliance.
Ambient Stream API
Find the API reference for the Ambient audio WebSocket stream.
Dictation Stream API
Find the API reference for the Dictation transcription WebSocket stream.
Resources
Refer to these pages when you need tutorials, capture guidance, FAQs, or partner support.Ambient WebSocket Tutorial
Build an Ambient streaming client with a full code example.
Dictation WebSocket Tutorial
Build a Dictation streaming client with a full code example.
Audio Capture Best Practices
Learn about PCM format, sample rate, chunking, and what to avoid before you open the WebSocket.
Audio Capture and Streaming FAQs
Find answers to questions about audio capture, streaming, and WebSocket implementation.
Support
Contact Suki for partner documentation and SDK support.