Skip to main content
Suki’s Headless Web SDK versioning policy is based on the semantic versioning standard. For example, in version 1.2.3, 1 is the major version, 2 is the minor version, and 3 is the patch version. When we release a new Headless Web SDK version for new features or bug fixes, we increment one of these three version components depending on the type of change introduced.
​
New Features
October 2026

​
New features

  • Optional microphone selection: Ambient recording accepts an optional deviceId so capture uses a specific audioinput device. Pass config.audio.deviceId to useAmbientSession, or pass { audio: { deviceId } } to startAmbientSession and resumeAmbientSession. Your app owns device enumeration and picker UI. Changing the microphone while recording requires pause() then resume(). There is no public switchMicrophone API. When an exact deviceId is unavailable, start or resume fails without falling back to the browser default.
Learn more in Select a microphone and Platform client and provider.
  • Embedded Forms: You can now seed Embedded Form templates and prior section text on an ambient session with setSessionContext or updateSessionContext using sections[].precharted_content. Mid-visit updates require updateMask such as ["sections"] and replace the full sections list. After the note is ready, read filled values from section_structured_values with getAmbientSessionStructuredData, getAmbientSessionSectionStructuredData, matching encounter helpers, and React hooks such as useUpdateAmbientSessionContext and useAmbientSessionSectionStructuredData. Your app decides when to refetch; the SDK does not poll Embedded Form results in the background. Note structured data does not include Embedded Forms in this release. Headed Web SDK UI and Form filling are out of scope for V1. Learn more in Embedded Forms overview.
​
New FeaturesEnhancements
September 2026

​
New features

  • Ambient interoperability: The Headless Web SDK now interoperates with other Suki products that support ambient workflows. Pass emrEncounterId when calling session.create() to associate the session with an EMR encounter. This lets the Headless Web SDK, Ambient APIs, Mobile SDK, and Web SDK contribute to and access the same clinical note for a patient visit. If session.create() fails with reason: "sessionAlreadyExists", another Suki product already has an active ambient session for the same encounter. Read blockingSessionId from error.additionalProperties, call cancelRemote or endRemote with that session id, then retry session.create(). Pass onSessionTerminatedByPeer to useAmbientSession to detect when another Suki product ends the live session. Update your UI to reflect the session state. Do not call local cancel(), submit(), cancelRemote(), or endRemote() for this direction. The SDK already tears down the local session.
  • Shared note listing: Use useGetEncounterInfo({ emrEncounterId }) to list note and session identifiers for an EMR encounter. Use Ambient API note-level endpoints with the returned note_id (or create response noteId) for note content, context, and structured data. The Headless Web SDK does not expose React hooks for note content reads.
  • Create response noteId: On a successful session.create(), the response now includes:
    • ambientSessionId (maps to Ambient API ambient_session_id).
    • noteId (maps to Ambient API note_id).
    When session.isSuccess is true, ambientSessionId and noteId are also available on the useAmbient hook return.
  • Patient identity on session context: setSessionContext now supports optional patient.patient_id and structured patient.name (family, given, suffix, use). An empty name object is dropped and is not sent. Name values are passed through as provided. The SDK does not force normalization.
Learn more in Ambient interoperability, Handle ambient session conflicts, Read shared ambient notes, Create ambient session, and Manage ambient session.
​
Bug Fixes
May 2026

​
Bug fixes

  • Minor bug fixes.
​
Enhancements
Jan 2026

​
Enhancements

  • Session type detection: Added sessionType property to the useAmbientSession hook. This property indicates whether a session was submitted while online or offline. Use it to display appropriate UI indicators and handle offline sessions differently in your application.
​
New Features
Dec 2025

​
New features

  • Initial beta release: First release of the Suki Headless Web SDK. Build custom ambient intelligence integrations with complete control over your user interface. Currently in beta stage for you to try out and provide feedback.
Last modified on October 16, 2026