Quick summary
Audio Dictation converts spoken speech into text in real time. Instead of typing into fields or note sections, providers can speak naturally while your application receives intermediate and final transcripts to insert, review, and save.
When to use Ambient documentation vs Audio Dictation
Ambient documentation and Audio Dictation solve different problems.- Use Ambient documentation when you want Suki to listen to a clinical conversation and help generate documentation from the encounter. Refer to Ambient clinical documentation.
- Use Audio Dictation when the provider needs direct control over the exact content, wording, structure, and pace of documentation.
- Speak naturally and receive transcribed text in real time.
- Insert text into fields, note sections, or a scratchpad without manual typing.
- Correct transcript text while clinical context is still fresh.
- Save or submit documentation after review.
- You need to choose where dictated text should land in your application.
- Capture provider speech with Dictation APIs, Web SDK, or Dictation SDK modalities.
- Receive intermediate and final transcript text.
- Insert text into the active target in your application, then let the provider review and save the transcript text.
Choose your path to build Audio Dictation
Suki provides three integration options for Audio Dictation workflows. Pick the one that matches how much UI and streaming control you want Suki to own, and how much you want to own, then open the matching quickstart to get started.Dictation APIs
If you need: full control over sessions, WebSocket audio, and transcript handling in your own UI.Your application owns create session, stream audio, render transcripts, and save text.
Web SDK
If you need: browser-based Dictation inside your own page layout and fields.Suki provides Dictation components and shared auth. Your application owns field focus and where final text goes.
Dictation SDK
If you need: hosted iframe-based Dictation with in-field or scratchpad modes.Suki manages the hosted Dictation experience. Your application handles callbacks that insert text into your UI.
Verify your first Dictation workflow
Before you design the full production workflow for Audio Dictation, confirm that your staging integration can complete the Dictation path for the product you chose:- Authenticate successfully for your chosen product.
- Start Dictation against a real target in your UI, such as a field, note section, or scratchpad.
- Capture provider speech.
- Receive transcript text in your UI or SDK callbacks.
- Insert or display that text in the active target.
- Let the provider correct the text, then save it in your application.
How Audio Dictation works
Across products, the clinician workflow for Audio Dictation is the same. The only difference is who owns each step. Refer to the table below to see who owns each step for each modality.
If you are building with Partner APIs, follow Dictation basic usage for how to create a session, stream audio, receive transcripts, and end the session.
Decide before you build your workflow
Before you pick Dictation APIs, Web SDK, or Dictation SDK for production, align on a few product decisions. Agree where dictated text lands, which Dictation mode you need, how providers move between fields, and how Ambient and Dictation work together if you offer both. These choices shape UX, integration timeline, and which Suki products you combine for a best-fit solution. Use the following sections to align your team.Define Where Dictated Text Lands
Define Where Dictated Text Lands
Be clear about where transcript text goes in your application. Common targets includes
- free-text note editor.
- single chart field.
- note section.
- scratchpad panel.
Decide If You Also Need Ambient
Decide If You Also Need Ambient
Ambient and Dictation solve different problems. Ambient listens to the visit and generates a structured clinical note after the session ends. Dictation gives the provider real-time control over exact wording in a field or note area.Many organizations need both. Decide early whether your app supports Dictation only, or Ambient plus Dictation.Make the choice obvious in the UI. Providers should know when to run an ambient session for the visit and when to dictate into a field, including when Dictation is used to correct ambient-generated text.
Choose In-Field, Scratchpad, or API-Owned UI
Choose In-Field, Scratchpad, or API-Owned UI
Mode choice depends on the product you use:
- In-field Dictation: Hosted Dictation over a specific input. Supported by Dictation SDK and Web SDK Dictation (
mode="in-field"). - Scratchpad Dictation: Hosted Dictation in a panel that is not tied to one field. Supported by Dictation SDK and Web SDK Dictation (
mode="scratchpad"). - API-owned UI: Your application owns create session,
/ws/transcribestreaming, transcript rendering, and insert logic. Use Dictation APIs.
Plan How Text Is Committed and Saved
Plan How Text Is Committed and Saved
Decide when transcript text becomes part of the chart.For Dictation SDK and Web SDK Dictation, commit text through callbacks such as
onSubmit, and optionally onDraft when the provider leaves without a final commit. Use a stable fieldId so your app knows which field to update. You can seed Dictation with initialText when the field already has content.For Dictation APIs, your application owns how partial and final transcript frames update the UI, and when the provider saves the final text in your EHR workflow.Partner webhooks for session completion are documented for Ambient and Form filling workflows. Dictation integrations rely on the live WebSocket transcript path and your application save logic.Plan Review and Correction
Plan Review and Correction
Providers should be able to correct transcript text while the visit context is still fresh.Decide:
- Whether correction happens in the field as text arrives, or after a longer dictate completes.
- How providers switch fields without inserting navigation commands into clinical text.
- When documentation is final in your application: save, sign, or submit.
Design the clinician workflow
After those decisions are clear, turn them into a Dictation workflow your team can build. Use this table to align on the answers.How to implement Audio Dictation
Next, align on the following implementation choices. These choices decide which Dictation product you use, how audio is captured, and how text reaches your UI.1. Map the end-to-end Dictation workflow
Walk the documentation task from focused field to saved text. For each step, name who owns it: your app, Suki hosted UI, or your backend. Typical stages:- Provider focuses a field, note section, or scratchpad target.
- Start Dictation for that target.
- Capture provider speech.
- Receive intermediate and final transcript text.
- Insert text into the active target.
- Let the provider correct the text, then save it in your application.
2. Choose your audio capture strategy
Dictation quality depends on clear speech capture and a stable real-time transcript path. Pick the product that matches who should own the microphone UI and transcript handling.
For Dictation APIs, stream on
GET /ws/transcribe. Send audio as documented for Dictation, use AUDIO_END when an utterance finishes, and handle partial and final frames with is_final. One Dictation session can support multiple speech bursts when the session returns to READY or IDLE. Refer to Dictation audio streaming and Audio capture best practices.
Design for clean real-time audio
Good audio is critical for Audio Dictation quality. Capture clear speech so Suki can return accurate transcript text in real time. Design your Dictation workflow so providers can:- Confirm that recording has started and stopped.
- See transcript text as speech is processed.
- Notice microphone or network issues during the session.
- Correct text while clinical context is still fresh.
3. Choose your Dictation mode and commit model
Decide how the provider starts Dictation and how text is committed.
For Dictation SDK and Web SDK, implement
onSubmit so committed text reaches the right field. Use onDraft when you need text from an incomplete session. Seed with initialText when the field already has content. Refer to Callbacks for Dictation SDK behavior.
4. Place text in your UI and save it
Dictation ends when your application has the transcript text the provider accepts. There is no Ambient-style clinical note retrieval step and no documented Dictation partner webhook completion flow. For Dictation SDK and Web SDK- Map
fieldIdto the correct input in your UI. - Apply committed text from
onSubmit. - Save or submit through your existing EHR or chart workflow.
- Update your UI from WebSocket transcript frames.
- Keep a cumulative transcript as frames arrive, including the complete transcript returned when you end the session when your integration uses that response.
- Persist the final text in your application after provider review.
generated_values. Keep each product’s output on its own save path.
Common integration patterns and use cases
Design your Dictation integration around where transcribed text must land and whether you own the streaming pipeline yourself or use an SDK. The following patterns show common ways to build Dictation workflows:In-Person Clinical Dictation
Capture provider Dictation during in-person encounters and return transcribed text to your documentation workflow.
Virtual Visit Documentation Screens
Capture provider Dictation in browser or API workflows used during virtual visits, then place transcript text into your documentation screens.
Populate Fields in Your Web App
Stream Dictation into note fields, forms, or scratchpad areas using Web SDK or Dictation SDK patterns.
Custom Transcription Pipeline
Own session lifecycle, audio capture, and transcript handling end to end with Partner REST and WebSocket APIs.
Measure success for Audio Dictation
Treat measurement as something you own. Define what better and worse means for your Audio Dictation workflow, track it where the work happens (your app + EHR), and use the findings before and after you deploy Dictation in production.
Start with a small set of metrics, for example time to complete target fields, edit rate after insert, and session failure rate, and later add more metrics as you deploy Dictation in production.
Next steps
Dictation audio streaming - Stream Dictation audio on/ws/transcribe.
Dictation basic usage - Build Dictation with Partner APIs when you own the streaming pipeline.
Web SDK Dictation - Add Dictation to browser JavaScript or React applications.
Dictation SDK quickstart - Embed hosted in-field or scratchpad Dictation.
Partner authentication - Get an sdp_suki_token for API and SDK calls.