> ## Documentation Index
> Fetch the complete documentation index at: https://developer.suki.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Suki Mobile SDK

> Add Ambient documentation to native iOS apps with a headless Mobile SDK for sessions, recording, and note generation

The Suki Mobile SDK is a headless iOS library that lets you add Ambient documentation to your native iOS application. You build the UI, while the SDK manages sessions, audio capture, and note generation.

Your application creates sessions, controls recording, and retrieves generated content. The SDK handles Ambient processing, while your application owns the clinician experience and how notes are written back to your EHR when applicable.

<Callout icon="handshake" color="orange">
  **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.

  <div style={{ marginTop: '0.75rem' }}>
    <a className="doc-guide-btn partner-contact-cta" href="https://www.suki.ai/suki-partners/" target="_blank" rel="noopener noreferrer">
      Contact Partnership Team
    </a>
  </div>
</Callout>

## Get started

Confirm requirements, install the SDK, and configure it before you create an Ambient session.

<Columns cols={3}>
  <Card title="Introduction" icon="book" href="/mobile-sdk/overview" arrow={true}>
    <p>Learn how the Mobile SDK works and when to use it in your iOS application</p>
  </Card>

  <Card title="Capabilities" icon="list-check" href="/mobile-sdk/features" arrow={true}>
    <p>Learn what the Mobile SDK supports for sessions, notes, offline recording, and interoperability</p>
  </Card>

  <Card title="Prerequisites" icon="clipboard-check" href="/mobile-sdk/prerequisites" arrow={true}>
    <p>Confirm iOS, Xcode, and Partner credential requirements before you install</p>
  </Card>

  <Card title="Install the SDK" icon="download" href="/mobile-sdk/installation" arrow={true}>
    <p>Add the Mobile SDK to your iOS project</p>
  </Card>

  <Card title="Configure the SDK" icon="sliders" href="/mobile-sdk/configuration" arrow={true}>
    <p>Configure the SDK so your application can create Ambient sessions</p>
  </Card>
</Columns>

## Ambient session lifecycle

Follow these guides in order to create a session, record audio, handle events, retrieve notes, and clear session state.

<Columns cols={3}>
  <Card title="Create Session" icon="play" href="/mobile-sdk/ambient-guides/create-session" arrow={true}>
    <p>Create an Ambient session and pass patient and encounter context</p>
  </Card>

  <Card title="Recording Controls" icon="microphone" href="/mobile-sdk/ambient-guides/recording" arrow={true}>
    <p>Start, pause, resume, and stop Ambient recording on device</p>
  </Card>

  <Card title="Session Events and Delegates" icon="bell" href="/mobile-sdk/ambient-guides/events-and-delegates" arrow={true}>
    <p>Handle session lifecycle events through Mobile SDK delegates</p>
  </Card>

  <Card title="Session Status and Content Retrieval" icon="file-lines" href="/mobile-sdk/ambient-guides/session-status-and-content-retrieval" arrow={true}>
    <p>Check session status and retrieve generated notes and structured data</p>
  </Card>

  <Card title="Clearing Sessions" icon="trash" href="/mobile-sdk/ambient-guides/clearing-sessions" arrow={true}>
    <p>Clear Ambient session state when the encounter is complete</p>
  </Card>
</Columns>

## Session capabilities

Add clinical context, shared notes across products, and offline recording when your iOS workflow needs them.

<Columns cols={3}>
  <Card title="Provide Clinical Context" icon="notes-medical" href="/mobile-sdk/ambient-guides/provide-clinical-context" arrow={true}>
    <p>Pass diagnosis and encounter context so generated notes stay aligned with the visit</p>
  </Card>

  <Card title="Interoperability" icon="share-nodes" href="/mobile-sdk/ambient-guides/ambient-interoperability" arrow={true}>
    <p>Continue the same clinical note across Ambient APIs, Mobile SDK, and Web SDK</p>
  </Card>

  <Card title="Offline Mode" icon="wifi" href="/mobile-sdk/ambient-guides/offline-mode" arrow={true}>
    <p>Buffer audio during network interruptions and sync when connectivity returns</p>
  </Card>
</Columns>

## Resources

Use these pages when you need error details, FAQs, release notes, or partner support.

<Columns cols={3}>
  <Card title="Error Messages" icon="triangle-exclamation" href="/mobile-sdk/error-messages" arrow={true}>
    <p>Find Mobile SDK error codes and how to handle them</p>
  </Card>

  <Card title="FAQs" icon="circle-question" href="/mobile-sdk/faqs/general" arrow={true}>
    <p>Find answers to installation, session, content, offline, and troubleshooting questions</p>
  </Card>

  <Card title="Changelog" icon="clock-rotate-left" href="/mobile-sdk/product-updates/changelog" arrow={true}>
    <p>Track Mobile SDK releases, enhancements, and breaking changes</p>
  </Card>

  <Card title="Support" icon="life-ring" href="/documentation/references/support" arrow={true}>
    <p>Contact Suki for partner documentation and SDK support</p>
  </Card>
</Columns>
