Suki SDKs

Suki provides npm packages and native SDKs to integrate Suki’s ambient intelligence capabilities. Features and integrations vary by SDK, so review changelogs and migration notes before upgrading.

Introduction

Suki SDKs help you add ambient documentation, form filling, and dictation to web and mobile applications. Choose the Web SDK, Headless Web SDK, Mobile SDK, or Dictation SDK based on your platform, UI needs, and workflow.

Install the SDK package, follow the product guide, and review the changelog before you upgrade. Use Suki APIs with SDKs when your backend needs server-side workflows or webhook integrations.

How it works

Configure authentication, initialize the SDK, then create or resume a session. Depending on the SDK, you stream audio, capture dictation, or retrieve generated clinical output.

Each SDK has its own authentication flow, supported features, and integration pattern. Review the SDK-specific guide before you deploy to staging or production.

Authentication

SDK access is available only to approved partners. CompletePartner onboarding

For credentials, staging access, or production rollout support, contactSupportor your Suki partnership contact.

Get Started Authentication

Installation Commands

Support & Best Practices

SDK support

support@suki.ai

Best practices

Store partnerId, partnerToken, and issued tokens securely; rotate credentials per your security policy.
Request microphone permission before capture starts; handle denial and prompts clearly in your UI.
Send SDK traffic over HTTPS; surface authentication failures and network errors using the patterns in each SDK guide.
Test across devices, OS versions, and network conditions before production rollout.
Always use the latest versions of the SDKs to get the latest features and bug fixes.

Languages

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

export function App() {
  return (
    <SukiProvider>
      {/* Your app */}
    </SukiProvider>
  );
}

import { SukiAuthManager } from '@suki-sdk/core';
import { initialize } from '@suki-sdk/js';

const authManager = new SukiAuthManager({
  partnerId: 'your-partner-id',
  partnerToken: 'your-partner-token',
  providerName: 'Jane Doe',
  providerOrgId: 'org-123',
  environment: 'production',
  loginOnInitialize: true,
});

const sdkClient = initialize({ authManager });

import SukiAmbientCore

SukiAmbientCoreManager.shared.environment = .stage

let partnerInfo: [String: AnyHashable] = [
    SukiAmbientConstant.kPartnerId: "your-partner-id",
    SukiAmbientConstant.kProviderInfo: [
        SukiAmbientConstant.kOrgId: "your-org-id",
        SukiAmbientConstant.kName: "Provider name",
        SukiAmbientConstant.kId: "provider-id",
        SukiAmbientConstant.kSpeciality: "FAMILY_MEDICINE",
    ],
]

try SukiAmbientCore.shared.initialize(
    withPartnerInfo: partnerInfo,
    with: true,
    onCompletion: { _ in },
    withSessionDelegate: self,
    withTokenProvider: self
)

Choose your SDK workflow

Available SDKs

Pick the SDK for your use case and workflow and start building your integration.

Decide Your SDK Path

Start building

Workflows OverviewLearn more about comparing SDKs and how to choose your integration path.Web SDK - Create SessionBuild your first ambient session, stream audio, and retrieve the note in minutes.Mobile SDK - Create SessionBuild your first ambient session, stream audio, and retrieve the note in minutes.Headless Web SDK - Create SessionBuild your first ambient session, stream audio, and retrieve the note in minutes.Dictation SDK - ConfigurationConfigure the Dictation SDK with your partner credentials and settings.Web SDK QuickstartBuild your first headed Web SDK flow in minutes.Headless Web SDK QuickstartBuild your first headless ambient flow in minutes.Partner OnboardingLearn more about partner onboarding to start using Suki SDKs.

Stay updated

Learn about the latest updates for the Web SDK, Mobile SDK, Headless Web SDK, and Dictation SDK.

Web SDK Changelog

Releases and migration notes for the headed Web SDK packages.

Mobile SDK Changelog

iOS SDK updates, deprecations, and behavior changes.

Headless Web SDK Changelog

Platform React package updates for ambient hooks and clients.

Dictation SDK Changelog

Dictation iframe and package updates for JavaScript and React tracks.

Suki SDKs

Introduction

How it works

Authentication

Installation Commands

Xcode: SukiAmbientCore.framework (Embed & Sign). See Mobile SDK installation.

Support & Best Practices

Best practices

Languages

Available SDKs

Web SDK

Mobile SDK

Headless Web SDK

Dictation SDK

Form Filling SDK

Start building

Stay updated

Web SDK Changelog

Mobile SDK Changelog

Headless Web SDK Changelog

Dictation SDK Changelog

Documentation Index

Suki SDKs

Introduction

How it works

Authentication

Installation Commands

Xcode: SukiAmbientCore.framework (Embed & Sign). See Mobile SDK installation.

Support & Best Practices

Best practices

Languages

Available SDKs

Web SDK

Mobile SDK

Headless Web SDK

Dictation SDK

Form Filling SDK

Start building

Stay updated

Web SDK Changelog

Mobile SDK Changelog

Headless Web SDK Changelog

Dictation SDK Changelog