Ambient Session Workflow Overview

Use useAuth, useAmbient, and useAmbientSession to authenticate users, create ambient sessions, and manage recording in the Headless Web SDK

Quick summary

The Suki Headless 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.

Last updated:August 2026

This section provides an overview of the React hooks available in the Suki Headless Web SDK. Refer to the cards below for more information on each hook.

Prerequisites to use the hooks

Before you begin, the following hooks require a partnerId and partnerToken:

• partnerId - The unique ID you receive when you first onboard with Suki.
• partnerToken - 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.

What are the hooks?

In React, a hook adds behavior to your components. The useAuth, useAmbient, and useAmbientSession hooks work together in a typical workflow to enable capabilities like:

• Authenticating users
• Creating ambient sessions
• Managing recording and submitting audio

You use these hooks to in your application to manage your ambient documentation workflow.

Workflow

Run the hooks in order. Each step depends on the output of the previous one.

Implementation guides

Choose the guide for the hook you want to implement:

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 ambientSessionId.