Get started
Start with the basics. Learn how to get started with Ambient documentation, what it is, and how to choose an integration path that supports your use case.Ambient Clinical Notes Overview
Learn when to use Ambient clinical notes, how the workflow works, and where to go next.
Ambient Documentation Guide
Learn how Suki generates structured clinical notes from patient-provider conversations.
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 for Ambient Documentation
Learn how to use the Web SDK for Ambient documentation.
Mobile SDK for Ambient Documentation
Learn how to use the Mobile SDK for Ambient documentation.
Headless Web SDK for Ambient Documentation
Learn how to use the Headless Web SDK for Ambient documentation.
Interoperability
Continue the same clinical note across Suki modalities that support interoperability.Ambient Interoperability
Learn how Ambient works across modalities and partner systems.
Interoperable Identifiers
Learn about identifiers that keep Ambient sessions and content aligned across products.
Use Ambient Across Modalities
Capture on one modality and continue review on another.
How-to guides
Build the Ambient product UI around session create, context, status, and content retrieval.Create an Ambient Session
Start Ambient and store session and note IDs.
Seed Ambient Session Context
Prepare visit context before Ambient ends.
Update Ambient Session Context
PATCH context as chart data arrives mid-visit.
End an Ambient Session
Stop, send end-of-audio, End, then poll status.
Handle Ambient Session Status
Drive the recorder and note panel from status.
Retrieve Ambient Content
Load note content, transcript, and structured data after the visit.
Retrieve Shared Notes Across Sessions
Choose session, note, or encounter APIs for multi-session notes.
Stream Ambient Audio in Your Product
Build recorder UI around /ws/stream.
Use Ambient Session Recordings
Listen-back and download with temporary recording URLs.
Collect Ambient Session Feedback
Rate the note after review.
Use Ambient Info APIs
LOINCs, specialties, visit types, and order enums for UI.
Features and concepts
Add these capabilities when your Ambient workflow needs advanced features like specialty coverage, language options, Problem-Based Charting, or Medication order content.Note Sections
Learn about LOINC note sections, SOAP vs a clinical note, and how to map content into the EHR.
Personalization
Learn how Ambient personalizes note output for clinicians.
Specialties
Learn about specialty coverage and how it affects Ambient note generation.
Multilingual
Configure language options for Ambient clinical documentation.
Problem-Based Charting
Pass problem context so Ambient notes organize findings around diagnoses.
Medication Orders
Learn about medication order content generated from Ambient sessions.
Embedded Forms
Get answers for the blanks in your note templates from the patient visit.
Resources
Refer to these pages when you need tutorials, interoperability FAQs, platform FAQs, or partner support.Ambient WebSocket Tutorial
Build an Ambient streaming client with a full code example.
Integration Decision Guide
Choose Ambient APIs or SDKs based on your app type, stack, and UI ownership.
Interoperability Best Practices
Find interoperability best practices, conflict handling, offline behavior, and FAQs.
Platform FAQs
Find answers to general, authentication, and security questions.
Support
Contact Suki for partner documentation and SDK support.