Developer Learning Path

Your journey to Suki integration

Follow this structured path to successfully integrate Suki’s AI-powered healthcare capabilities. Each step builds on the previous one, ensuring you have a solid foundation before moving forward.

Estimated Total Time: 4-6 weeks from start to production deployment

Foundation setup

Step 1: Partner onboarding

Goal: Get registered with Suki and receive your

What You'll Do

Contact Suki partnership team
Provide business information and authentication method
Receive your unique partner_id

Prerequisites: Business information, chosen authentication methodTime: 3-5 business daysNext Step: Once you have your partner_id, move to Step 2

Start Partner Onboarding

Step 2: Authentication setup

Goal: Configure secure authentication between your system and Suki

What You'll Do

Choose authentication method (, Okta, JWT Assertion)
Set up your identity provider integration
Test token generation and validation

Prerequisites: from Step 1, access to your identity providerTime: 2-3 daysNext Step: With authentication working, choose your integration path

Setup Authentication

Integration choice

Step 3: Choose your integration path

Goal: Select the best integration method for your application

Web SDK

Best for: React/JavaScript web apps that want Suki UI

Pre-built clinical UI components
Automatic state management
Fastest browser implementation

Headless Web SDK

Best for: React 18+ web apps with a custom UI

Hooks for auth, sessions, and recording
You build all interface and layout
Same core ambient behavior as the Web SDK

Mobile SDK

Best for: Native iOS applications

Optimized for mobile audio
Native performance
Offline capabilities

Direct APIs

Best for: Custom implementations on any stack

Maximum flexibility
Any programming language
Full control at the API/WebSocket level

Time: 1-2 hours to evaluate options

Decision Guide

Implementation

Web SDK path
Headless Web SDK path
Mobile SDK path
API path

Step 4a: Web SDK setup

Goal: Install and configure the Suki Web SDK

Install package (15 min)

Install @suki-sdk/core plus @suki-sdk/react for React or @suki-sdk/js for plain JavaScript

npm install @suki-sdk/react @suki-sdk/core

Next: Initialize auth and the SDK client (see quickstart for your stack)

Basic configuration (30 min)

Create SukiAuthManager from @suki-sdk/core with your partnerId, partnerToken, and provider fields. In React, wrap with SukiProvider and call init({ authManager }) from useSuki() in a child (once, usually from useEffect). In JavaScript, call initialize({ authManager }) from @suki-sdk/js.

import { SukiProvider } from '@suki-sdk/react';

function App() {
  return (
    <SukiProvider>
      {/* init({ authManager }) from useSuki() in a child */}
    </SukiProvider>
  );
}

Next: Mount the UI and start an ambient session

First ambient session (45 min)

Mount the SDK UI with an encounter and walk through recording and note generationWhat you’ll build: A simple flow that starts ambient documentation, captures audio, and returns a clinical noteNext: Test with sample audio and verify note generation

Web SDK quickstart →

Step 4b: Headless Web SDK setup

Goal: Install the Headless Web SDK and wire authentication and ambient hooks in React

Install package (15 min)

Install the Headless Web SDK in a React 18+ project

npm install @suki-sdk/platform-react

Confirm your test and production host URLs are on the Suki allowlist (see Headless Web SDK prerequisites).Next: Add PlatformClient and PlatformClientProvider

Platform client and provider (20 min)

Create a PlatformClient and wrap your app with PlatformClientProvider (see Platform client and provider and Quickstart)

import { PlatformClient, PlatformClientProvider } from '@suki-sdk/platform-react';

const client = new PlatformClient({ env: 'staging', enableDebug: true, logLevel: 'error' });

function App() {
  return (
    <PlatformClientProvider>
      <YourApp />
    </PlatformClientProvider>
  );
}

Next: Authenticate with useAuth inside the provider tree

Authentication hooks (45 min)

Add the useAuth hook under the provider with your partnerId and partnerToken (see the Authentication hook guide)

import { useAuth } from '@suki-sdk/platform-react';

function YourApp() {
  const { isLoggedIn, isPending, error, login } = useAuth({
    partnerId: 'your-partner-id',
    partnerToken: 'your-partner-token',
    // See Authentication hook guide for full options
  });
  // Render your own sign-in UI and loading states
}

Next: Create an ambient session with useAmbient

Session and recording (60 to 90 min)

Create a session with useAmbient, then use useAmbientSession for recording lifecycle and statusWhat you’ll build: Your own controls and layout (start, pause, submit) backed by hook state, plus retrieval of note content when processing completesNext: Follow the quickstart through your first end-to-end recording, then harden error handlingFor step-by-step code, use the quickstart and Authentication hook, Ambient hook, and Ambient session hook guides.

Headless Web SDK quickstart →

Step 4c: Mobile SDK setup

Goal: Install and configure the Suki Mobile SDK

Install framework (20 min)

Add the Suki Mobile SDK to your iOS projectMethods: SPM, CocoaPods, or manual installationNext: Configure permissions and capabilities

Basic configuration (45 min)

Initialize the SDK and set up basic configuration

import SukiSDK

SukiSDK.configure(
    partnerId: "your-partner-id",
    environment: .staging
)

Next: Implement session management

First ambient session (60 min)

Create a basic ambient session with recording capabilitiesWhat you’ll build: A view controller that can create sessions, record audio, and retrieve generated notesNext: Test with device microphone and verify functionality

Mobile SDK installation →

Step 4d: Direct API integration

Goal: Implement Suki’s APIs directly in your application

Authentication implementation (60 min)

Implement the authentication flow to get Suki tokensKey endpoints: /auth/register, /auth/loginNext: Test token generation and validation

Session management (90 min)

Implement ambient session creation and managementKey endpoints:

POST /ambient-sessions - Create session
POST /ambient-sessions/{id}/context - Set context
GET WebSocket - Audio streaming

Next: Implement audio streaming

Content retrieval (45 min)

Implement note generation monitoring and content retrievalKey endpoints:

GET /ambient-content/{id}/status - Check status
GET /ambient-content/{id}/content - Get generated note

Next: Test end-to-end workflow

API overview →

Advanced features

Estimated Time: 1-2 weeks

Step 5: Add advanced capabilities

Goal: Enhance your integration with Suki’s advanced features

Multilingual Support

Time: 2-3 hoursEnable support for 80+ languages with automatic English note generationKey Features:

Automatic language detection
Multi-language conversations
English output standardization

Problem-Based Charting

Time: 4-6 hoursImplement diagnosis-focused documentation structureKey Features:

Problem-oriented notes
Diagnosis tracking
Enhanced clinical workflows

Custom Note Sections

Time: 2-4 hoursConfigure custom clinical note sections using LOINC codesKey Features:

26+ standard sections
Custom section ordering
EHR integration ready

User Preferences

Time: 3-5 hoursAllow providers to customize their documentation preferencesKey Features:

Personal note styling
Section preferences
Workflow customization

Production readiness

Estimated Time: 1 week

Step 6: Testing & optimization

Goal: Ensure your integration is production-ready

What you will do

Comprehensive testing with real clinical scenarios
Performance optimization and error handling
Security review and compliance verification
User acceptance testing with healthcare providers

Key areas:

Audio quality and streaming reliability
Note generation accuracy and speed
Error handling and recovery
HIPAA compliance verification

Time: 3-5 days

Step 7: Go live

Goal: Deploy your Suki-powered application to production

Production deployment

Switch to production environment
Monitor initial usage and performance
Gather user feedback and iterate
Scale based on usage patterns

Support resources:

24/7 technical support during launch
Performance monitoring and alerts
Regular check-ins with Suki team

Get Support

Next steps

If you have all the required information and partner_id, start with the Getting started guide to get oriented. Then open the quickstart or overview for your path: Web SDK, Headless Web SDK, Mobile SDK, or API overview.

Get Started

Onboarding & Authentication

Product Capabilities

Guides

Help & Support

Developer Learning Path

Your journey to Suki integration

Foundation setup

Step 1: Partner onboarding

What You'll Do

Step 2: Authentication setup

What You'll Do

Integration choice

Step 3: Choose your integration path

Web SDK

Headless Web SDK

Mobile SDK

Direct APIs

Implementation

Step 4a: Web SDK setup

Step 4b: Headless Web SDK setup

Step 4c: Mobile SDK setup

Step 4d: Direct API integration

Advanced features

Step 5: Add advanced capabilities

Multilingual Support

Problem-Based Charting

Custom Note Sections

User Preferences

Production readiness

Step 6: Testing & optimization

What you will do

Step 7: Go live

Production deployment

Next steps

Get Started

Onboarding & Authentication

Product Capabilities

Guides

Help & Support

Documentation Index

​Your journey to Suki integration

​Foundation setup

​Step 1: Partner onboarding

What You'll Do

​Step 2: Authentication setup

What You'll Do

​Integration choice

​Step 3: Choose your integration path

Web SDK

Headless Web SDK

Mobile SDK

Direct APIs

​Implementation

​Step 4a: Web SDK setup

​Step 4b: Headless Web SDK setup

​Step 4c: Mobile SDK setup

​Step 4d: Direct API integration

​Advanced features

​Step 5: Add advanced capabilities

Multilingual Support

Problem-Based Charting

Custom Note Sections

User Preferences

​Production readiness

​Step 6: Testing & optimization

What you will do

​Step 7: Go live

Production deployment

​Next steps

Your journey to Suki integration

Foundation setup

Step 1: Partner onboarding

Step 2: Authentication setup

Integration choice

Step 3: Choose your integration path

Implementation

Step 4a: Web SDK setup

Step 4b: Headless Web SDK setup

Step 4c: Mobile SDK setup

Step 4d: Direct API integration

Advanced features

Step 5: Add advanced capabilities

Production readiness

Step 6: Testing & optimization

Step 7: Go live

Next steps