> ## 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 SDKs Overview
> Compare Suki SDKs for Ambient, Form filling, Dictation, and Patient Summary workflows, then jump to quickstarts, changelogs, and integration guides
export const SOV = {
supportEmail: "support@suki.ai",
calloutTag: "Note",
decide: {
title: "Not sure which SDK fits?",
body: "Compare hosted UI, headless, and native paths side by side before you build."
},
pillIcons: {
JavaScript: "js",
React: "react",
Swift: "swift",
iOS: "apple"
},
pillTones: {
GA: "ga",
BETA: "beta"
},
tileTones: {
workflows: "yellow",
quickstart: "yellow",
auth: "yellow",
"patient-summary": "yellow",
web: "blue",
headless: "blue",
dictation: "blue",
api: "blue",
websocket: "blue",
mobile: "cream",
webhook: "cream",
"form-filling": "cream",
guidelines: "cream"
},
paths: {
all: "M4 4h7v7H4zM13 4h7v7h-7zM4 13h7v7H4zM13 13h7v7h-7z",
ambient: "M3 12h3.5l2.5-6 4 12 2.5-6H21",
dictation: "M9 6a3 3 0 0 1 6 0v6a3 3 0 0 1-6 0zM5.5 11.5a6.5 6.5 0 0 0 13 0M12 18v3",
form: "M8 4h8v3H8zM6 5.5H5v15h14v-15h-1M8.5 12h7M8.5 16h5",
summary: "M5 4h14v16H5zM8.5 9h7M8.5 12.5h7M8.5 16h4",
grid: "M4 4h7v7H4zM13 4h7v7h-7zM4 13h7v7H4zM13 13h7v7h-7z",
code: "M8 7l-5 5 5 5M16 7l5 5-5 5",
phone: "M7.5 3h9v18h-9zM11 18h2",
headless: "M4 5h16v14H4zM8 10l2.5 2L8 14M12.5 14H16",
rocket: "M5 16.5c-1.5 1.3-2 5-2 5s3.7-.5 5-2c.7-.8.7-2.1-.1-2.9a2.2 2.2 0 0 0-2.9-.1zM12 15l-3-3a22 22 0 0 1 2-4A12.9 12.9 0 0 1 22 2c0 2.7-.8 7.5-6 11a22.4 22.4 0 0 1-4 2zM9 12H4s.5-3 2-4c1.6-1.1 5 0 5 0M12 15v5s3-.5 4-2c1.1-1.6 0-5 0-5",
key: "M7.5 8.5a3.5 3.5 0 1 0 0 7a3.5 3.5 0 1 0 0-7M11 12h9.5M17.5 12v3M20.5 12v2",
braces: "M9 4H7.5A2.5 2.5 0 0 0 5 6.5v3A2.5 2.5 0 0 1 2.5 12 2.5 2.5 0 0 1 5 14.5v3A2.5 2.5 0 0 0 7.5 20H9M15 4h1.5A2.5 2.5 0 0 1 19 6.5v3a2.5 2.5 0 0 0 2.5 2.5 2.5 2.5 0 0 0-2.5 2.5v3a2.5 2.5 0 0 1-2.5 2.5H15",
bell: "M6 10a6 6 0 0 1 12 0v4l2 3H4l2-3zM10 20a2 2 0 0 0 4 0",
bars: "M4 14h4v6H4zM10 10h4v10h-4zM16 6h4v14h-4z",
file: "M6 3h8l4 4v14H6zM14 3v4h4",
download: "M12 4v11M7 10l5 5 5-5M5 20h14",
check: "M5 12.5l4.5 4.5L19 7",
arrow: "M4 12h16M14 6l6 6-6 6",
book: "M4 4.5h6a2 2 0 0 1 2 2v13a2 2 0 0 0-2-2H4zM20 4.5h-6a2 2 0 0 0-2 2v13a2 2 0 0 1 2-2h6z"
},
art: {
ink: "#1B1B1B",
paper: "#FFFDF7",
skel: "#DCD7C9",
yellow: "#FDF49D",
yellowEdge: "#E9D25A",
blueBar: "#9CCBF2"
}
};
export const sovUtil = {
safe: (fn, fallback) => {
try {
return fn();
} catch (e) {
return fallback;
}
},
flat: n => Array.isArray(n) ? n.flatMap(sovUtil.flat) : n == null || typeof n === "boolean" ? [] : [n],
isEl: n => !!(n && typeof n === "object" && n.props),
isBoundary: n => {
const p = n.props;
return typeof p.name === "string" && sovUtil.isEl(p.children) && Object.keys(p).every(k => k === "name" || k === "children");
},
unwrap: n => {
let x = n;
while (sovUtil.isEl(x) && sovUtil.isBoundary(x)) x = x.props.children;
return x;
},
els: node => sovUtil.flat(node).map(sovUtil.unwrap).filter(sovUtil.isEl),
findAll: (node, type, out = []) => {
sovUtil.flat(node).forEach(raw => {
const n = sovUtil.unwrap(raw);
if (!sovUtil.isEl(n)) return;
if (n.type === type) out.push(n); else sovUtil.findAll(n.props.children, type, out);
});
return out;
},
find: (node, type) => sovUtil.findAll(node, type)[0],
has: (node, type) => !!sovUtil.find(node, type),
textOf: n => sovUtil.flat(n).map(x => typeof x === "string" || typeof x === "number" ? String(x) : sovUtil.isEl(x) ? sovUtil.textOf(x.props.children) : "").join(""),
split: s => String(s || "").split(",").map(x => x.trim()).filter(Boolean)
};
export const SovGlyph = ({k, size = 16, sw = 1.6}) => {children}
;
export const SovKeyed = ({list}) => sovUtil.flat(list).map((el, i) => {el} );
export const SovCopyBtn = ({text, label = "Copy"}) => {
const [done, setDone] = useState(false);
const go = async () => {
try {
await navigator.clipboard.writeText(text);
setDone(true);
setTimeout(() => setDone(false), 1500);
} catch (e) {}
};
return
{done ?
{done ? "Copied" : "Copy"}
;
};
export const SovArt = ({label, children}) => {children} ;
export const SovLine = ({x, y, w, c = SOV.art.skel}) =>
;
export const SovBarcode = ({x, y, n, h = 24}) =>
{Array.from({
length: n
}).map((_, i) => {
const tall = [1, 0.5, 0.75, 0.5, 1, 0.33, 0.75, 0.5][i % 8];
const bh = Math.round(h * tall / 2) * 2;
return ;
export const SovPill = ({label}) => {
const name = SOV.pillIcons[label];
const tone = SOV.pillTones[label];
const hasIcon = typeof Icon !== "undefined";
const cls = ["sov-ptag", name && hasIcon ? "sov-ptag-logo" : "", tone ? `sov-ptag-${tone}` : ""].filter(Boolean).join(" ");
return
{name && hasIcon && ;
};
export const SdkFilterIconAmbient = () => {children} ;
export const OverviewCtaRow = ({children}) => {children}
;
export const OverviewInstallRow = () => null;
export const OverviewDownloadList = ({children}) => {
const rows = sovUtil.findAll(children, OverviewInstallRow).map(r => ({
label: r.props.label,
clip: r.props.clipboard,
text: sovUtil.textOf(r.props.children).trim(),
aria: r.props.ariaLabel
}));
const [i, setI] = useState(0);
if (!rows.length) return {children}
;
const r = rows[Math.min(i, rows.length - 1)];
const isComment = r.text.startsWith("#");
return
{rows.map((x, n) => setI(n)}>{x.label} )}
{isComment ? {r.text} : <>$ {r.text}}
;
};
export const OverviewHeroMain = ({title, lead, children}) =>
{title}
{lead &&
{lead}
}
{children}
;
export const OverviewHeroSection = ({title, children}) => ;
export const OverviewHeroSteps = ({children}) => {children} ;
export const OverviewHeroAside = ({ariaLabel, children}) => ;
export const OverviewMetaCard = ({title, children}) => ;
export const OverviewMailRow = ({label = "Support", email = SOV.supportEmail}) => ;
export const OverviewMetaBestPractices = ({children}) => {
const tip = sovUtil.els(children)[0];
return {tip && tip.props.children ? tip.props.children : children}
;
};
export const OverviewHero = ({kicker, children}) => {
const u = sovUtil;
const main = u.find(children, OverviewHeroMain);
const aside = u.find(children, OverviewHeroAside);
if (!main) return {children}
;
const sections = u.findAll(main.props.children, OverviewHeroSection);
const ctas = u.find(main.props.children, OverviewCtaRow);
const howSec = sections.find(s => u.has(s.props.children, OverviewHeroSteps));
const introSecs = sections.filter(s => s !== howSec);
const cards = aside ? u.findAll(aside.props.children, OverviewMetaCard) : [];
const stepsEl = howSec && u.find(howSec.props.children, OverviewHeroSteps);
const steps = stepsEl ? u.els(stepsEl.props.children) : [];
const howIntro = howSec ? u.flat(howSec.props.children).filter(n => u.unwrap(n) !== stepsEl) : [];
return
{kicker &&
{kicker}
}
{main.props.title}
{main.props.lead &&
{main.props.lead}
}
{ctas}
{introSecs.map((s, i) =>
)}
{cards.length > 0 &&
{cards.map((c, i) => {
const bp = u.find(c.props.children, OverviewMetaBestPractices);
if (bp) {
const mail = u.find(c.props.children, OverviewMailRow);
return
{mail}
{bp}
;
}
const install = u.has(c.props.children, OverviewInstallRow);
return ;
})}
}
{howSec &&
{howSec.props.eyebrow &&
{howSec.props.eyebrow}
}
{howSec.props.title}
{steps.map((li, i) =>
{String(i + 1).padStart(2, "0")}
{li.props.children}
)}
}
;
};
export const OverviewHeroSections = ({children}) => {children}
;
export const OverviewHeroText = ({callout, children}) => callout ?
{typeof callout === "string" ? callout : SOV.calloutTag}
{children}
: {children}
;
export const OverviewMetaStack = ({children}) => {children}
;
export const OverviewDownloadRow = ({href, name}) =>
{name}
;
export const OverviewKvStack = ({children}) => {children}
;
export const OverviewKv = ({label, children}) =>
{label &&
{label} }
{children}
{children}
;
export const OverviewKvLink = ({href, children}) => {children} ;
export const OverviewInlineLink = ({href, children}) => {children} ;
export const OverviewInlineCode = ({value, ariaLabel}) =>
{value}
;
export const OverviewMetaHint = ({children}) => {
const tip = sovUtil.els(children)[0];
return {tip && tip.props.children ? tip.props.children : children}
;
};
export const OverviewArtWeb = () => {
const A = SOV.art;
return
;
};
export const OverviewArtMobile = () => {
const A = SOV.art;
return
;
};
export const OverviewArtHeadless = () => {
const A = SOV.art;
return
;
};
export const OverviewArtMic = () => {
const A = SOV.art;
return
;
};
export const OverviewArtForms = () => {
const A = SOV.art;
return
)}
;
};
export const OverviewArtWave = () => {
const A = SOV.art;
return
;
};
export const OverviewArtSummary = () => {
const A = SOV.art;
return
{[56, 92, 128].map(y =>
)}
;
};
export const OverviewWorkflowSection = ({eyebrow, titleId, title, lead, children}) =>
{eyebrow && {eyebrow}
}
{title}
{lead && {lead}
}
{children}
;
export const SdkCardTipPanel = ({what, whenWhy, features = []}) =>
{what &&
{what}
}
{whenWhy &&
{whenWhy}
}
{features.length > 0 &&
}
{name}
{pills.length > 0 && {pills.map(p => }
{tip && View {name} docs
;
};
export const OverviewWorkflowCards = ({id, ariaLabel, children}) => {
const n = sovUtil.findAll(children, OverviewWorkflowCard).length;
return {children}
;
};
export const SdkWorkflowFilterPill = ({label, children}) => {children}{label} ;
export const SdkWorkflowFilter = ({children}) => {
const u = sovUtil;
const pills = u.findAll(children, SdkWorkflowFilterPill);
const cardsWrap = u.find(children, OverviewWorkflowCards);
const cards = cardsWrap ? u.findAll(cardsWrap.props.children, OverviewWorkflowCard) : [];
const start = (pills.find(p => p.props.active) || pills[0] || ({
props: {
value: "all"
}
})).props.value;
const [on, setOn] = useState(start);
useEffect(() => {
const v = u.safe(() => new URLSearchParams(window.location.search).get("workflow"), null);
if (v && pills.some(p => p.props.value === v)) setOn(v);
}, []);
const pick = v => {
setOn(v);
u.safe(() => {
if (!(/^https?:$/).test(window.location.protocol)) return;
const sp = new URLSearchParams(window.location.search);
if (v === "all") sp.delete("workflow"); else sp.set("workflow", v);
const qs = sp.toString();
window.history.replaceState(window.history.state, "", window.location.pathname + (qs ? `?${qs}` : "") + window.location.hash);
});
};
const shown = cards.filter(c => on === "all" || u.split(c.props.workflows).includes(on));
return
{pills.map(p => {
const v = p.props.value;
const n = v === "all" ? cards.length : cards.filter(c => u.split(c.props.workflows).includes(v)).length;
return pick(v)}>
{v === "all" ?
{n}
;
})}
{shown.map(c => {c} )}
;
};
export const SdkWorkflowFilterBar = ({children}) => {children}
;
export const OverviewDecideCta = ({href, ariaLabel, title = SOV.decide.title, body = SOV.decide.body, children}) => ;
export const OverviewStartSection = ({title, lead, children}) =>
{title}
{lead && {lead}
}
{children}
;
export const OverviewStartGrid = ({children}) => {children}
;
export const OverviewStartTile = ({href, variant, title, desc, children}) =>
{children}
{title} {desc && {desc} } ;
export const OverviewMintlifyCardgroup = ({children}) => {
const cards = [];
const walk = n => sovUtil.els(n).forEach(x => {
if (typeof x.props.title === "string" && x.props.href) cards.push(x.props); else walk(x.props.children);
});
walk(children);
if (!cards.length) return {children}
;
return ;
};
Suki SDKs help you build clinical AI into healthcare software for providers, nurses, and other care staff. Ambient documentation, Form filling, Dictation, and Patient Summary are the core workflows you can embed in web and mobile apps. Each SDK handles client-side authentication, audio streaming, and session management.
Choose a hosted clinical UI, or a headless SDK when you want to build your own experience. For server-side session setup, webhooks, or note retrieval, use the Suki REST APIs with the SDK.
Features and upgrade requirements vary by SDK. Review each product's changelog and migration guide before upgrading.
Each SDK follows the same integration pattern:
Configure authentication
Initialize the SDK
Create or resume a clinical session
Capture audio or user input
Receive clinical output such as transcripts, notes, completed forms, or a Patient Summary
Get Started
Authentication
npm install @suki-sdk/react @suki-sdk/core
# Xcode: SukiAmbientCore.framework (Embed & Sign). See Mobile SDK installation.
npm install @suki-sdk/platform-react
npm install @suki-sdk/core @suki-sdk/dictation-react @suki-sdk/dictation
npm install @suki-sdk/core @suki-sdk/form-filling-react @suki-sdk/form-filling
#### 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.
Decide Your SDK Path
Releases and migration notes for the headed Web SDK packages.
iOS SDK updates, deprecations, and behavior changes.
Platform React package updates for ambient hooks and clients.
Dictation iframe and package updates for JavaScript and React tracks.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.