When to use Ambient documentation
Use Ambient documentation when you need:- Structured clinical notes from patient-provider conversation without typing the note during the encounter.
- LOINC-coded sections, optional structured data, and transcript content you control in your application. Capture and review across Ambient APIs, Web SDK, Mobile SDK, or Headless Web SDK, including shared notes across modalities.
Developer workflow
The Ambient developer workflow is shared by Ambient APIs, Web SDK, Mobile SDK, and Headless Web SDK. The only difference is who owns each step.1
Create Session
Start an ambient session for the visit. Provide patient details, note sections, and provider information. Suki returns a session ID. With Web SDK or Headless Web SDK, start through the SDK controls or hooks.
2
Record Conversation
Stream audio while the visit runs. Ambient APIs stream over WebSocket on
/ws/stream. Web SDK, Mobile SDK, and Headless Web SDK handle capture for you.3
End and Generate
End the ambient session when that recording finishes. Suki analyzes the transcript, extracts clinical content, and organizes it into the sections you requested.
4
Retrieve and Review
Retrieve the note with LOINC-coded sections, optional structured data, and the transcript when you need it. Let the provider review, edit, and submit into the EHR workflow.
Related guides
Ambient Documentation Guide
Workflow decisions, capture strategy, note quality settings, and EHR handoff.
Ambient Interoperability
Continue the same clinical note across Ambient APIs, Web SDK, and Mobile SDK.
Create an Ambient Clinical Note
Start Ambient and store session and note IDs for your product UI.
Ambient Audio Streaming
Stream visit audio on
/ws/stream for Ambient API integrations.Resources
Refer to these guides when you are ready to integrate:Ambient API Overview
Orient to Ambient and Dictation Partner APIs, auth, and core resources.
Ambient API Quickstart
Create a session, stream audio, and retrieve ambient content end to end.
Web SDK
Browser capture and review UI from Suki for Ambient documentation.
Headless Web SDK
Custom React UI with ambient hooks for session and recording control.