Web SDK For Audio Dictation Overview

Add Dictation to JavaScript or React apps with SukiAuthManager, DictationClient, and Web SDK Dictation components in Web SDK

This section walks you through the process of integrating Dictation capabilities using the Suki Web SDK in a browser-based JavaScript or React application. You will use the packages provided by Suki to complete the integration.

To implement Dictation, you must create a SukiAuthManager and a DictationClient.

In a React application, you wrap your component tree with the DictationProvider. You then render the Dictation component when you want the user to dictate. In a JavaScript application, you call await dictationClient.show({ ... }) when the user is ready to begin Dictation.

Prerequisites

Before you begin, meet the necessary requirements in Web SDK prerequisites and obtain partnerId and partnerToken after Partner onboarding.

Integration guides

Choose the integration guide for your stack:

JavaScript

Use the JavaScript package provided by Suki Web SDK to integrate audio Dictation in a JavaScript application (browser-based).

React

Use the React package provided by Suki Web SDK to integrate audio Dictation in a React application (browser-based).

For options such as mode, fieldId, and callbacks, refer to the Configuration guide in the Dictation SDK section.

Web SDK Dictation uses the same hosted Dictation iframe as the Dictation SDK, so Content Rewrite is available there too when backend enablement allows it. You do not add a new ShowOptions field or callback. Refer to Content Rewrite for the clinician flow and what stays the same in your integration.