Suki home pagelight logodark logo
  • Support
Documentation
API
Mobile SDK
Web SDK
Documentation
  • Overview
  • Installation
  • Quickstart
Guides
  • Ambient Session
  • Note Management
  • Error handling
  • Token Refresh
  • Branding
API Reference
  • Types
  • Classes
  • Functions
  • Hooks
  • Providers
  • Components
Examples
  • Basic Usage
  • Control Visibility
  • Dynamic Encounter
  • Ambient events
  • Test mode
  • Using the SDK Inside an Iframe
  • Advanced Configuration
  • Theming and Customization
Product Updates
  • Changelog
  • Migrating to Suki.js v2
FAQs
  • Automatic User Onboarding
  • General
  • Technical
  • Implementation
FAQs

General

1. What is the Suki SDK?

Suki Software Development Kit (SDK) enables developers to embed Suki’s voice AI capabilities directly into their application. Healthcare solutions including electronic health records (EHRs), healthcare overlay applications such as ACOs, medical devices, and more can now easily incorporate AI voice features directly into their offerings. The Suki SDK comes with an out-of-the-box UI component that automatically manages the user state and error handling, providing a seamless user experience without requiring explicit control from the developer.

2. How does Suki SDK work?

The clinician will use the partner application installed on their device (mobile/web) to initiate the ambient session. The Suki SDK records the clinician-patient conversation or clinician monologue in real-time, streaming it to the server. In cases of network instability, the recording occurs offline on the client device. The SDK’s UI enables users to start, stop, and pause voice recordings, handling microphone access, audio capture, encryption, encoding, and data transmission. It also manages system-level interruptions like incoming calls or messages, delegating them to the partner application.Note Generation and Editing: Upon completing the voice recording, the clinician can generate the note. The Suki SDK transcribes and diarizes the recording using Suki’s automatic speech recognizer (ASR) to create a transcript, which is then combined with other relevant patient information to produce a new patient note. This note is processed by Suki’s fine-tuned Language Models (LLMs) to generate ambient note suggestions. By default, a basic SOAP note template is used unless otherwise specified. The SDK also enables clinicians to edit the generated note through voice dictation or typing. Finally, the Suki SDK allows the parent app to retrieve the final note in LOINC coded JSON format or write back the generated notes and sections using provided APIs.

3. What platforms does the Suki SDK support?

Currently, the Suki SDK supports web interfaces that use ReactJS and JavaScript.

4. What are the main benefits of the Suki SDK?

Ease of Integration: Developers can integrate the Suki SDK in their application with minimal effort, requiring only a few lines of code, ensuring a quick and smooth integration process.

Flexibility and Customizability: The Suki SDK offers developers the flexibility to customize the user interface elements to align with their branding guidelines and style of their applications.

User Experience: Suki’s AI capabilities are available directly within partner applications, which eliminates the need for users to switch contexts. This streamlined workflow enhances efficiency and gives clinicians a more intuitive user experience.

Assistant
Responses are generated using AI and may contain mistakes.
Automatic User OnboardingTechnical
Suki home pagelight logodark logo
xlinkedin
System Status

About

Contact UsTerms of UsePrivacy PolicyTrust Center
xlinkedin
xlinkedin
Powered by Mintlify