Skip to main content

Technical execution at a glance

Learn how to integrate Suki SDKs and APIs into your product. Go through this technical execution guide for technical requirements and the integration process for our developer tools.

How integration works

These four phases apply across the Web SDK, Mobile SDK, Headless Web SDK, and SDP REST APIs. Your surface changes how you implement each step; use the Critical technical requirements section below for checklists by product.

Setup and configuration

Partner ID, security (JWKS), and environment setup. Install the Web or Headless package, embed the Mobile SDK, or configure SDP REST API clients.

Authentication

Connect your IdP, issue partner tokens, and validate access for embedded SDKs or server-side SDP API calls.

Ambient session and AI

Run sessions with Web or Headless UI, native mobile capture, or API-driven flows. Stream audio, receive transcript and structured clinical note.

Note delivery

Receive structured payloads (JSON), map to your formats, and route to chart, record, or downstream systems.

What partners need

To use our developer tools, you need to have the following:

✓ Identity & Security System

An existing authentication system (OAuth 2.0 or similar) is the foundation. The SDK connects to what’s already in place. Most organizations already meet these requirements.

✓ Development environment

Teams shipping a browser client with React (@suki-sdk/react) or JavaScript (@suki-sdk/js) are ready. Server-rendered-only stacks still need a supported client bundle. Standard tools and package managers are all that’s needed.

✓ Clinical knowledge

Clinical teams already understand their specialties and documentation requirements. That expertise configures the SDK for optimal note generation.

✓ Structured data path

Ability to receive structured payloads and route them into charts, care plans, billing, or other downstream systems. The SDK delivers LOINC-oriented note data your services can map and persist.

✓ Audio capabilities

Standard web browser microphone permissions and HTTPS connections. Capabilities every modern web application already supports.

✓ User information

Stable identifiers and context for the person using the SDK (for example, physician, nurse, case manager, or virtual care role), plus organization or tenant IDs you already store.

Integration Methods

Web SDK

Use our pre-built browser UI with the Web SDK for React or JavaScript to get started quickly.

View Checklist

Mobile SDK

Use our native iOS SDK to integrate Suki clinical intelligence into your native iOS applications.

View Checklist

SDP REST APIs

Use our SDP REST APIs and webhooks to integrate Suki clinical intelligence into your backend or custom client.

View Checklist

Headless Web SDK

Use our headless Web SDK to integrate Suki clinical intelligence into your web application with full control over your own user interface.

View Checklist

Integration timeline

From concept to production in weeks, not months.

Build & customize

SDK integration and UI customization so the experience matches your product.

Total time to value

2-4 weeks from start to production launch. Compare that to 6-12 months building ambient AI from scratch.

Week 1
Week 2–3
Week 4
Go-live

Kickoff

Partner onboarding and environment setup.

Validate & ship

Testing, QA, and production deployment with confidence.

Expanded reference

Critical technical requirements (Web SDK)

These five areas require attention for smooth deployment. Each requirement is standard for modern healthcare web applications.

Authentication

Requirements

  • OAuth 2.0 compliant identity provider or custom JWT generation system
  • Publicly accessible JWKS endpoint (HTTPS) for token verification
  • JWT tokens signed with RS256 algorithm
  • Required claims: exp, iss, aud, and user identifier

Why it matters: Secure authentication is the foundation of trust. Get this right from the start, and everything else flows smoothly.

Partner Authentication Guide

Installation

Requirements

  • React or JavaScript development environment
  • Node.js with npm, pnpm, or yarn package manager
  • ES6 compatible browser environment

Package selection

  • React apps: install @suki-sdk/react
  • Non-React browser apps: install @suki-sdk/js

Why it matters: Match the package to the stack. React apps get React-optimized components. The JS package targets browser JavaScript outside React. This avoids unnecessary complexity.

Installation Guide

Specialties information

Requirements

  • List of medical specialties the application supports
  • Understanding of LOINC codes for clinical note sections
  • Mapping between encounter types and appropriate LOINC codes

Why it matters: Context is everything. A cardiology note looks different from a behavioral health note. Proper configuration ensures notes are clinically appropriate and perfectly formatted for partner workflows.

Supported SpecialtiesLOINC Codes and Note SectionsSpecialty Context

Note output and downstream integration

Requirements

  • Infrastructure to receive note submission events or callbacks
  • Logic to parse LOINC-encoded JSON structure
  • Workflow to map Suki’s output format to your systems of record or handoff targets

Why it matters: Completed notes arrive as LOINC-encoded JSON. Partner systems receive structured, ready-to-use data for charts, exports, or internal services. No manual translation needed.

Note Submission and Retrieval

Microphone permissions

Requirements

  • Microphone access permission flow in the application
  • HTTPS connection for production (required for microphone access)
  • Iframe configuration if embedding: add allow=“microphone; clipboard-write; clipboard-read” attributes

Why it matters: Audio capture is essential. Without proper microphone permissions, the system can’t function. Ensure permissions are requested and iframe configurations are correct.

Iframe Permissions Guide