- Ambient
- Dictation
Complete the session after streaming audio
After sending the finalRU9G message, close the WebSocket connection and complete the ambient session with REST.1
Close the WebSocket Connection
Close the WebSocket connection from the client when you are done sending audio for that segment.
2
End the Session Using REST
End the session using End ambient session API.
3
Retrieve Results Using REST
Poll session status and fetch transcript and structured data using these REST APIs:
Final transcripts and notes are not guaranteed to arrive over WebSocket. Treat REST APIs as the source of truth.
Troubleshooting common issues while streaming audio
Use this table to troubleshoot common ambient streaming errors. It explains what each error or behavior means, why it occurs, and how to resolve it.Available cookbooks
Available tutorials
Ambient
Build an Ambient Streaming Client
Authenticate, create a session, stream PCM audio over WebSocket, and retrieve clinical note results.
Dictation
Build a Dictation Streaming Client
Create a transcription session, stream audio, read partial frames, and print the final transcript.
Form filling
Build a Form filling Session Client
Create a Form filling session, send template context, stream audio, and retrieve structured form data.