Skip to main content
Suki for Partners provides different integration paths for adding ambient clinical documentation and dictation capabilities to your application. Each integration path is designed for different product requirements, implementation approaches, and levels of UI ownership. This guide explains the available integration options for ambient and dictation workflows and helps you select the approach that best fits your application architecture, technology stack, and user experience goals. Use this guide to understand the tradeoffs between each integration path, including how much workflow logic, audio handling, and UI customization your team manages. For form filling workflows, please refer to the Form filling integration decision guide.

​
Integration options

​
Ambient APIs

Ambient APIs are the most flexible integration option and allow you to build your own user interface and authentication flow for your application.

Recommended for:

• Backend systems and server integrations
• Custom user interfaces on any stack
• Multi-platform applications

What you build:

• Complete user interface
• Authentication flow
• Audio handling and API/WebSocket usage

​
Web SDK

The Web SDK delivers pre-built clinical UI components and handles authentication and audio processing for browser-based healthcare applications.

Recommended for:

• Web-based healthcare applications
• Browser-based EHR integrations
• Teams that want pre-built clinical UI

What's provided:

• Pre-built UI components
• Authentication handling
• Audio processing

​
Headless Web SDK

The Headless Web SDK provides React hooks for authentication and ambient sessions while you build a fully custom interface.

Recommended for:

• React web applications (React 18+)
• Custom UI that matches your design system
• Full control over recording controls, status, and layout

What's provided:

• React hooks for auth and ambient sessions
• Core ambient, streaming, and session behavior
• No pre-built clinical UI (you build the interface)

​
Mobile SDK

The Mobile SDK offers native iOS integration for ambient workflows on mobile devices.

Recommended for:

• Native iOS applications
• Mobile healthcare apps
• Apps requiring native device features

Platform support:

• iOS (available now)
• Android (in development)

​
Dictation

The Dictation SDK embeds hosted dictation in your web application via iframe and JavaScript or React packages.

Recommended for:

• Web applications that need dictation
• Frontend systems that need dictation

What's provided:

• Hosted iframe for dictation
• In-field and scratchpad modes
• JavaScript and React packages

​
How to choose

Choose Web SDK if:
  • You want pre-built clinical UI components
  • You prefer the fastest path to a browser-based integration with Suki-provided UI
Choose Headless Web SDK if:
  • You use React 18 or higher and want hooks for auth, sessions, and recording
  • You need a custom interface, branding, or workflows that pre-built components do not cover
  • You want SDK-managed session and audio behavior while owning all presentation
Choose Direct APIs if:
  • Your client is not React, or you integrate from multiple client types against the same API surface
  • You want full control at the REST/WebSocket level without an SDK on the web client
For iOS Applications:
  • Choose Mobile SDK - provides native iOS functionality and device integration
For Android Applications:
  • Choose Direct APIs - Mobile SDK for Android is currently in development
Choose Direct APIs
  • This is your only option for server-to-server integrations
  • Provides complete control over data processing and system integration
HIPAA Compliance: All integration methods can be implemented in a HIPAA-compliant manner. Compliance depends on your implementation practices and security measures.

​
Prerequisites for all integration methods

Before integrating with any Suki Platform method, you must complete the partner onboarding process:

​
Required for all integration methods

Partner Registration:
  • Complete the Partner onboarding process
  • Receive your unique partner_id from Suki
  • Provide your JWKS endpoint URL to Suki for token validation
Authentication System:
  • OAuth 2.0 compliant authentication system
  • JWT token generation with consistent user identifier
  • Publicly accessible JWKS endpoint for token verification

​
Additional requirements by method

Web SDK:
  • ES6+ compatible browsers
  • Host URLs whitelisted with Suki for SDK embedding
Headless Web SDK:
  • React 18.0 or higher
  • ES6+ compatible browsers
  • Host URLs for your test and production apps provided to Suki for allowlisting (see Headless Web SDK prerequisites)
Mobile SDK (iOS):
  • iOS 14.0 or later
  • Xcode development environment
  • Audio recording permissions in your app
Ambient APIs:
  • WebSocket client implementation capability
  • HTTPS/TLS support for secure API communication
Dictation SDK:
  • ES6+ compatible browsers
  • Host URLs for your test and production apps provided to Suki for allowlisting (see Dictation SDK prerequisites)

​
Integration scenarios

Scenario: Existing web-based Electronic Health Record system needing ambient clinical documentationRecommended: Web SDK• Integrates directly into your existing web application
• Provides pre-built clinical note interface
• Handles audio streaming and note generation automatically
Scenario: Healthcare patient portal where providers can document encounters during telehealth visitsRecommended: Web SDK• Ready-to-use telehealth documentation interface
• Built-in audio processing for web browsers
• Seamless integration with existing patient management systems
Scenario: Web EHR or clinician workflow where ambient capture must match your design system, layout, and interaction patternsRecommended: Headless Web SDK (React 18+)• React hooks for authentication, session lifecycle, and recording control
• You implement controls, status, and note presentation
• Same core ambient capabilities as the Web SDK without pre-built clinical UIIf you are not on React, use Direct APIs for an equivalent level of UI ownership.

​
Next steps

To begin your integration, review the documentation for your chosen approach:

Web SDK Quickstart

Get started with pre-built components and fast integration

Headless Web SDK Quickstart

React hooks, custom UI, and ambient sessions in your application

API Overview

Build custom integrations with maximum flexibility

Mobile SDK Overview

Native iOS integration for mobile applications

Dictation SDK Overview

Hosted dictation in your web application

Partner Onboarding

Start your integration journey with Suki

​
Get personalized integration guidance

If your use case doesn’t clearly match the scenarios above, or you need specific technical advice for your healthcare application, our customer success team provides personalized consultation. Before contacting support or sales, please prepare:
  • Description of your healthcare application and clinical workflows
  • Target platform (web with React or not, iOS, Android, backend system)
  • Development timeline and resource constraints
  • Specific technical requirements or compliance needs
Contact options:
Last modified on June 12, 2026