Quick summary
The Suki Web SDK provides three primary hooks to manage your ambient documentation workflow:
useAuth for identity, useAmbient to create a session and obtain an ambientSessionId, and useAmbientSession to record, pause, resume, and submit audio for that session.Overview
This section provides an overview of the React available in the Suki Headless Web SDK. Refer to the cards below for more information on each hook.Prerequisites
Before you begin, the following hooks require apartnerId and partnerToken:
partnerId-The unique ID you receive when you first onboard with SukipartnerToken- The secure access token for the user, generated by your EHR system
If you do not have a
partnerId and partnerToken, refer to the Authentication guide for more information.Typical workflow
In React, a hook adds behavior to your components. TheuseAuth, useAmbient, and useAmbientSession hooks work together in a typical workflow:
Hook implementation guides
Choose the guide for the hook you are implementing:Authentication
Use this hook to manage authentication state for the Headless Web SDK.
Create Ambient Session
Use this hook to create a session and obtain an
ambientSessionId.Manage Ambient Session
Use this hook to control recording and submit audio using the
mbientSessionId.