Skip to main content

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.

Featured use cases

Start with paths many clinical and operational partners implement first.

AmbientAutomate clinical documentation from the visit

Draft clinical notes from encounter audio while you control capture and authentication.

Ambient APIsWeb SDKMobile SDKHeadless Web SDK
Form fillingComplete structured medical forms from visit audio

Turn visit conversation into template-driven form output for your workflow.

Form Filling APIsREST

All use cases

Form fillingTemplate-driven form sessions

Bind Suki medical form templates to a session and retrieve structured output.

Form Filling APIsTemplates
Form fillingStructured form output and EHR handoff

Retrieve generated form values and route them into review, save, or handoff flows.

Form Filling APIsStructured data
AmbientProblem-based charting and structured note content

Align generated notes to problems, sections, and chart-aware titles.

Web SDKHeadless Web SDKAmbient APIs
AmbientMedication orders and richer session context

Enrich sessions so drafts reflect medication orders and chart context.

Ambient APIsMobile SDK
AmbientSession audio for playback or download

Request short-lived recording access for replay or archival jobs.

Ambient APIs
AmbientWebhooks and asynchronous session completion

Receive HTTPS callbacks when ambient sessions complete or fail.

WebhooksAmbient APIs
DictationHosted browser dictation for fields and scratchpads

Add hosted speech-to-text to web fields or scratchpad workflows.

Dictation SDKJavaScriptReact
DictationAPI-driven real-time dictation without hosted UI

Create transcription sessions, stream audio, and handle partial and final transcripts.

Dictation APIsWebSocket
AmbientTelehealth and shared browser audio capture

Capture ambient audio inside browser telehealth and shared-audio setups.

Web SDK
AmbientFully custom ambient UI with React hooks

Build a fully custom ambient React UI with Headless Web SDK hooks (beta).

Headless Web SDKReactBeta
AmbientNote sections and structured documentation outputs

Shape generated notes into predictable sections for downstream systems.

Web SDKAmbient APIs
DictationChoose the right dictation integration path

Compare API, Web SDK, and Dictation SDK options for speech-to-text.

Dictation APIsDictation SDK
DictationReal-time dictation streaming over WebSocket

Send JSON audio messages and receive partial and final transcript frames.

WebSocketDictation APIs
AmbientOffline-capable ambient capture (React)

Plan ambient capture for brief connectivity loss in React.

Headless Web SDKReact
AmbientCompact ambient UI with minimized layout

Run ambient capture in a compact Web SDK footprint when space is tight.

Web SDK
AmbientPersonalization and preference-aware ambient behavior

Send personalization payloads so generation honors provider and organization settings.

Ambient APIs
Form fillingChoose the Form Filling API path

Confirm Form Filling API ownership across web, mobile, and backend teams.

Form Filling APIsGuide

Partner case studies and press

HealthEdge and Suki: ambient care management
Read more
Ambient notes on the athenahealth network
Read more
Zoom and Suki: AI clinical notes
Read more
EHRs and ambient listening (Azalea Health)
View case study
Suki news