Skip to main content

​
Overview

The Suki Web SDK provides a seamless way to manage clinical notes, content retrieval, and note lifecycle within your web application. This guide will walk you through the process of integrating the Web SDK with your application to enable note generation, submission, and retrieval capabilities.

​
Note Generation

Once an ambient session is submitted, the Suki Platform begins generating a note asynchronously in the background. The time it takes to generate the note depends on the session’s connectivity mode:
  • Online Mode: The system processes audio in real time as the conversation happens. This results in faster note generation after the session is submitted.
  • Offline Mode: The system must first upload the entire audio file after the connection is restored. This may increase generation time, depending on the length of the conversation.
For more information about offline mode, refer to offline mode guide. Generated notes are securely stored in the Suki system and are only accessible via the SDK UI.

​
Note Submission And Retrieval

You can submit and retrive generated note using the web SDK. The web SDK provides the final note contents back to your application so you can save the data to your EHR. You can receive this data in two ways:
  • (React) onNoteSubmit prop: The (recommended method) for React. You can pass a callback function directly to the SukiAssistant component.
  • (React/JavaScript) note-submission:success event: You can listen for this global event using the on method.
The following examples show how to implement both approaches.
  • Javascript
  • React
The code snippet below shows how to listen for the note-submission:success event to receive the note contents in JavaScript.
JavaScript

const unsubscribeNoteSubmission = sdkClient.on("note-submission:success", (contents) => {
  console.log("Note submitted successfully:", contents);
});

​
Next Steps

Refer to Token Refresh guide to learn more about how to refresh the token and keep the session alive.