Get started
Confirm requirements, install the SDK, and configure it before you create an Ambient session.Introduction
Learn how the Mobile SDK works and when to use it in your iOS application
Capabilities
Learn what the Mobile SDK supports for sessions, notes, offline recording, and interoperability
Prerequisites
Confirm iOS, Xcode, and Partner credential requirements before you install
Install the SDK
Add the Mobile SDK to your iOS project
Configure the SDK
Configure the SDK so your application can create Ambient sessions
Ambient session lifecycle
Follow these guides in order to create a session, record audio, handle events, retrieve notes, and clear session state.Create Session
Create an Ambient session and pass patient and encounter context
Recording Controls
Start, pause, resume, and stop Ambient recording on device
Session Events and Delegates
Handle session lifecycle events through Mobile SDK delegates
Session Status and Content Retrieval
Check session status and retrieve generated notes and structured data
Clearing Sessions
Clear Ambient session state when the encounter is complete
Session capabilities
Add clinical context, shared notes across products, and offline recording when your iOS workflow needs them.Provide Clinical Context
Pass diagnosis and encounter context so generated notes stay aligned with the visit
Interoperability
Continue the same clinical note across Ambient APIs, Mobile SDK, and Web SDK
Offline Mode
Buffer audio during network interruptions and sync when connectivity returns
Resources
Use these pages when you need error details, FAQs, release notes, or partner support.Error Messages
Find Mobile SDK error codes and how to handle them
FAQs
Find answers to installation, session, content, offline, and troubleshooting questions
Changelog
Track Mobile SDK releases, enhancements, and breaking changes
Support
Contact Suki for partner documentation and SDK support