PlatformClient, wraps the tree with PlatformClientProvider, and uses hooks such as useAuth, useAmbient, and useAmbientSession. The SDK manages Ambient session logic, while your application owns the clinician experience and how results are written back to your EHR when applicable.
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
React hooks
Use these hooks to authenticate, create Ambient sessions, and control recording 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
Integration Patterns
Learn common ways to wire Headless hooks into your application
Session capabilities
Add offline buffering and network-transition behavior when your Ambient sessions run in unreliable network conditions.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 reference
Look upPlatformClient, 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