NewThe Web SDK is now with other Suki products that support Ambient workflows. Pass a shared encounter identifier so clinicians can continue the same clinical note across Ambient APIs, Mobile SDK, and Web SDK.Refer to Ambient interoperability for Web SDK setup.
- Ambient note generation
- Medical transcription
- Note management
- Form filling
- Dictation
- Medication orders
- Interoperability with other Suki products
- Write submitted notes to your EHR
Common integration patterns and use cases
The Web SDK provides a pre-built ambient UI for recording, review, editing, and submission in the browser. Your application owns mount configuration, submission handling, and how notes are written back to your EHR. The following examples show common ways to integrate the Web SDK into your web application.Capture Ambient Notes with Pre-Built UI
Mount the headed Web SDK in your web app so clinicians can record, review, and edit ambient notes in Suki’s UI, then handle note submission in your application.
Edit Notes with Built-In Dictation
Use the Web SDK’s built-in Dictation controls while clinicians review an ambient note so they can correct or add text without leaving the editor.
Capture Problem Context
Pass PBC sections and existing diagnoses in
ambientOptions so the note organizes findings around problems and merges EMR diagnoses with the visit discussion.Capture Medication Orders
Enable LOINC
52471-0, let the provider review orders in the SDK UI, then read orders from the note submission payload and persist them to your EHR after the session completes.Continue Notes from Another Suki Product
Open an interoperable ambient note in the Web SDK after capture on another Suki product, such as the Mobile SDK or Ambient APIs, so clinicians can review, edit, and submit on desktop.
Write Submitted Notes to Your EHR
Listen for note submission callbacks, map section content and optional orders into your charting model, and persist the final documentation in your EHR.
Supported platforms
The SDK is supported on the following platforms:React
The SDK is supported on React.Install the Suki Web SDK for React:
Vanilla JavaScript
The SDK is supported on Vanilla JavaScript.Install the Suki Web SDK for Vanilla JavaScript:
Other Frameworks
The SDK is supported on other frameworks like Vue, Angular, etc.
While it is optimized for React, you can also easily integrate it with vanilla JavaScript or other frameworks.
If you are using
@suki-sdk/js or @suki-sdk/react, you can use the Core and Dictation from the package itself. You do not need to install the @suki-sdk/core and @suki-sdk/dictation packages separately.How the Web SDK works
The following diagram illustrates the Web SDK architecture and workflow:Architecture workflow
Client Side (Your Web Application)
- Your React, JavaScript, or web app that integrates the SDK
- Core SDK package that handles authentication, session management, and communication
- Pre-built UI for recording, transcription, and note display
Suki Backend
- Validates partner credentials (Partner ID and token)
- Manages audio streaming and processing
- Processes audio in real-time and generates structured clinical notes
Data Flow
- Initialize SDK with partner credentials → Authenticate with Suki’s backend
- Mount pre-built UI with encounter data
- User starts recording → SDK streams audio to ambient Service
- AI Engine processes audio and generates notes
- Results return through Suki Backend → UI displays the note and transcript
Web SDK capabilities
Ambient Note Generation
The SDK allows you to automatically capture spoken patient encounters and generate structured clinical notes in real time.
Context-Aware Processing
Context-Aware Processing
It uses AI to intelligently organize medical conversations into the correct clinical sections.
Smart Formatting
Smart Formatting
It uses LOINC codes to segment content into sections like
HPI, Assessment, and Physical Exam.Background Processing
Background Processing
The feature runs passively in the background during consultations so it does not disrupt the provider’s workflow.
Medical Transcription
Integrate high-accuracy medical transcription that supports specialty-specific terminology and multiple languages and accents.
Specialty-Specific Terminology
Specialty-Specific Terminology
The transcription supports specialty-specific terminology.
Multiple Languages and Accents
Multiple Languages and Accents
The transcription supports multiple languages and accents.
Note Management
The SDK includes features for managing clinical notes within your application.
Note Editor
Note Editor
A rich-text editor designed specifically for AI-generated clinical content. It supports editing, formatting, and section-level interaction.
Note Archive
Note Archive
A feature that allows users to view and manage both current and historical notes associated with a patient.
Key benefits
The web SDK provides the following benefits:Fast Integration
Fast Integration
Quickly add Suki’s features using our built-in UI.
Optimized Performance
Optimized Performance
Built for accuracy and speed in a web environment.
Focus on Your Application
Focus on Your Application
Let our components handle the Suki UI so your team can focus on your product.