Skip to main content

Integrate with the Suki Headless Web SDK to get Suki’s ACI capabilities, such as Ambient documentation, in a headless React SDK with hooks for authentication, sessions, and recording, and build the clinician UI yourself.

Find your use case β†’

Headless Web SDK Ambient session controls in a custom EMR UIHeadless Web SDK Ambient session controls in a custom EMR UI
Are you a Suki partner?To use any Suki API or SDK, you must be a Suki partner. Contact the partnership team to begin the onboarding process. They help you set up your authentication system and get started with the Suki APIs and SDKs.

​
Get started

Confirm requirements, install the SDK, authenticate, and run your first Ambient session.

Introduction

Learn how the Headless Web SDK works and when to use it in your application.

Prerequisites

Confirm React version, Partner credentials, and setup requirements before you install.

Install the SDK

Install @suki-sdk/platform-react and add the SDK to your application.

Authenticate

Learn how Partner Tokens and provider identity work with Headless Web SDK hooks.

Run Your First Session

Initialize, authenticate, and run an Ambient session end to end.

​
Integrate Headless Web SDK hooks

Use these hooks and guides to authenticate, create ambient sessions, configure recording, select a microphone, and build a recording UI from your own React UI.

Hooks Overview

Learn how useAuth, useAmbient, and useAmbientSession fit together.

Authentication Hook

Authenticate users and manage identity with useAuth.

Create Ambient Session

Create an Ambient session and get an ambientSessionId with useAmbient.

Manage Ambient Session

Record, pause, resume, and submit audio with useAmbientSession.

Configure Ambient Session

Parameters, return values, and session context for useAmbientSession.

Select a Microphone

Pass an optional microphone deviceId for ambient recording.

Ambient Session Examples

Full recording UI example and Headless Ambient tutorials.

Integration Patterns

Learn common ways to wire Headless hooks into your application.

​
Headless Web SDK capabilities

Add offline buffering, network-transition behavior, and cross-product ambient note sharing when your ambient sessions need those capabilities.

Ambient Interoperability

Share one clinical note across Ambient APIs, Mobile SDK, Headless Web SDK, and Web SDK.

Session Conflicts

Clear a blocking remote session, then retry create. Keep UI in sync on remote end.

Read Shared Notes

List notes with useGetEncounterInfo and seed patient context for Web SDK handoff.

Offline Mode

Buffer audio during network interruptions and sync when connectivity returns.

Network Transitions

Learn how the SDK behaves when the browser goes online or offline.

​
API references

Look up PlatformClient, provider setup, and TypeScript types when you need exact contracts.

Platform Client and Provider

Initialize PlatformClient and provide it to your React tree.

Types

Browse Headless Web SDK types for sessions, auth, and responses.

​
Resources

Use these pages when you need examples, tutorials, error handling, release notes, or partner support.

Authentication Example

Browse an authentication example for the Headless Web SDK.

Auth and Session Flow

See how authentication and Ambient session flow fit together.

Ambient Tutorial

Build an Ambient recorder with Headless Web SDK hooks.

Error Handling

Handle Headless Web SDK errors during authentication and Ambient sessions.

FAQs

Find answers to general, technical, and implementation questions.

Changelog

Track Headless Web SDK releases, enhancements, and breaking changes.

Support

Contact Suki for partner documentation and SDK support.

Last modified on September 29, 2026