For full version history and code samples, use each product’s changelog: API, Web SDK, Mobile SDK, Headless Web SDK.
Deprecated
API v1.1.1Multilingual parameter: We’ve deprecated themultilingual parameter in the Create Ambient Session endpoint. Multilingual support is now enabled by default when you call the API.Learn more in the Create Ambient Session API reference.New features and enhancements
Headless Web SDK 0.2.2Session type detection: We’ve added asessionType property to the useAmbientSession hook.It indicates whether a session was submitted while online or offline, so you can display appropriate UI indicators and handle offline sessions differently.Learn more in the Headless Web SDK changelog.Enhancements
Web SDK 2.1.1Multilingual capability is now enabled by default in the Web SDK. Patients and providers can speak in their preferred language; the SDK generates the clinical note in English. No configuration is required, and you do not need to contact Technical Support to enable this feature.Optional patient fields: We’ve made thebirthDate and gender properties optional on the Patient type.You can omit these fields when creating patient objects if the information is not available.Removed
Web SDK 2.1.1AmbientOptions: We’ve removed theprefill.noteTypeIds property from the AmbientOptions type.You must use the sections property instead.New features and enhancements
API v1.1.0Audio transcription API: We’ve added support for real-time audio transcription.Create transcription sessions, stream transcription data, and end sessions to get final transcripts for dictation, captioning, and transcript generation.- POST
/api/v1/transcription/session/create - POST
/api/v1/transcription/session/{id}/end - GET
/ws/transcribe(WebSocket)
setSessionContext: visit type, encounter type, provider role, reason for visit, and chief complaint to improve note accuracy.Headless Web SDK 0.1.1Initial beta release: We’ve released the first beta of the Headless Web SDK for building custom ambient integrations with full UI control.Learn more in the Headless Web SDK changelog.New features and enhancements
Web SDK 2.1.0Telehealth audio capture: We’ve added the ability to capture audio from separate tabs in the same browser window (e.g. Zoom, Teams) for accurate ambient documentation during virtual visits.This feature is opt-in and disabled by default.Learn more in the Telehealth guide.Enhancements
API v1.0.1Code examples: We’ve added code examples in Python and TypeScript for all SDP APIs.New features and enhancements
API v1.0.0Info endpoints and context: We’ve introduced three info endpoints for supported enum values (encounter types, visit types, provider roles) and updated ambient session context to supportVisitContext (e.g. chief complaint, visit type) and enhanced provider context (e.g. provider_role).Learn more in Info endpoints and ambient session context.iOS SDK 2.4.0User feedback and audio buffer: We’ve added submitFeedback(_:for:onCompletion:) for feedback on AI-generated content and the audioBufferFilled(withPercentage:) delegate for connection status in the UI.Enhancements
API v1.0.0Documentation: We’ve added API Reference Guidelines, restructured and enhanced API documentation, rewritten the Problem-Based Charting guide, and added detailed authentication guidance for the Audio Streaming API.Learn more in the API changelog.iOS SDK 2.4.0Offline handling: We’ve added a 15-second buffer before transitioning to offline mode to handle temporary connection problems and allow connection status notifications in the UI.iOS SDK 2.4.0Getting started guide: We’ve improved the getting started guide with a workflow diagram to help you understand the process of using the Suki Mobile SDK.Removed
API v1.0.0SNOMED and paused state: We’ve removed support for SNOMED codes in the diagnosis context.We’ve also removed support for the paused state for ambient sessions.Learn more in the Ambient session context API reference.Enhancements
Web SDK 2.0.4Event monitoring: We’ve added six new authentication events and five new ambient session lifecycle events to theEmitterEvents type for login, registration, token refresh, and session state changes.Learn more in EmitterEvents.Web SDK 2.0.4Offline handling: We’ve added a 15-second buffer before transitioning to offline mode to handle temporary connection problems.Web SDK 2.0.4User feedback: We’ve added the ability to collect user feedback on AI-generated content directly through the SDK.New features and enhancements
iOS SDK 2.3.0Personalization preferences: We’ve addedsetPersonalizationPreferences(_:completionHandler:) to configure verbosity levels and note section styles (narrative or bulleted) for supported LOINC sections.iOS SDK 2.2.1Diagnosis context and structured data: We’ve added SukiAmbientConstant.kDiagnosisInfo to setSessionContext for diagnosis context and getStructuredData(for:onCompletion:) for structured output and diagnoses (ICD-10, IMO, SNOMED).New features and enhancements
Web SDK 2.0.3Bearer token authentication: We’ve added support for Bearer token authentication by allowing you to passproviderId during SDK initialization.iOS SDK 2.2.0Session context method: We’ve introduced setSessionContext(with:onCompletion:) for setting patient, provider context, and LOINC codes after session creation, with improved session workflow and LOINC integration.Resolved issues
Web SDK 2.0.3Ambient event and ID state: We’ve fixed incorrectisAmbientInProgress and isAmbientPaused flags in ambient:update events and fixed activeAmbientId not resetting in the useSuki hook after a session is submitted or cancelled.Removed
Web SDK 2.0.3Section editing: We’ve removed the insert script option from section editing in the note page.New features and enhancements
Web SDK 2.0.2Problem-based charting: We’ve added support for problem-based charting (PBN) with LOINC via theisPBNSection property in ambientOptions.Learn more in the ambient guide.iOS SDK 2.1.0Audio buffering and multilingual: We’ve implemented audio buffering to reduce offline sessions caused by brief internet interruptions and added SukiAmbientConstant.kMultilingual for multilingual processing support.Enhancements
Web SDK 2.0.1Default UI options: We’ve updated default values foruiOptions to match the latest UI configuration: close button, start ambient button, dictation, copy, and insert script are enabled by default; create empty note is disabled by default.iOS SDK 2.1.0Background recording handling: We’ve added proper error handling when attempting to start recording while the app is backgrounded, providing clearer error messages and preventing unexpected behavior.