> ## 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. # Partner Use Cases > Partner scenarios for EHRs, telehealth, care management, revenue cycle, and related applications: Ambient, Dictation, and Form filling. Search, filter, open a card, then use View documentation. export const UCSearchIcon = () => ( );

Suki for Partners

Featured use cases

Start with paths many clinical and operational partners implement first.

Ambient Automate clinical documentation from the visit

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

Ambient APIsWeb SDKMobile SDKHeadless Web SDK
Ambient APIs Web SDK Mobile SDK Headless Web SDK

Capture encounter audio in your product and generate draft clinical documentation using the Suki developer platform.

You control authentication, session lifecycle, and audio capture. The Suki Platform processes approved audio and structured clinical data to return draft clinical notes.

Use this integration when you want clinicians to stay inside your EHR, telehealth product, or care workflow while your backend orchestrates note generation using APIs, streaming endpoints, and webhooks.

Level Advanced Est. time ~4 hours

Related links

  • Ambient APIs Manage sessions, stream data, retrieve outputs, and handle webhooks.
  • Web SDK Add browser-based audio capture with minimal setup.
  • Mobile SDK Capture encounter audio in native iOS applications.
  • Headless Web SDK Build a fully custom capture experience using React hooks.

How Suki supports this

  • Ambient APIs let you create and manage sessions, stream audio, retrieve generated notes, and receive completion events via webhooks.
  • Web SDK provides a ready-to-use browser capture experience.
  • Mobile SDK enables native iOS audio capture.
  • Headless Web SDK gives you React hooks to build a custom capture UI.

Implementation checklist

  1. Set up partner authentication and generate access tokens.
  2. Choose your integration approach using the integration decision guide.
  3. Create your first session using the Ambient API quickstart.
  4. Stream or upload encounter audio and send structured clinical context.
  5. Handle webhook events to retrieve generated documentation.

What to read next

Start with Ambient clinical documentation, then explore the Ambient API overview and your selected SDK documentation for deeper integration patterns.

` }} />
Form filling Complete structured medical forms from visit audio

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

Form Filling APIsREST
Form Filling APIs REST

Capture visit audio and retrieve structured medical form output while you keep the form UX, session lifecycle, and downstream save logic in your product.

You own the form experience, template selection, recording controls, and downstream review flow. Suki processes visit audio and returns structured form data for Suki medical form templates instead of generating a full ambient clinical note.

Use this integration when clinicians complete nursing forms, intake forms, assessments, medication reviews, or other template-based workflows where the output must land in defined fields instead of free-text note sections.

Level Medium Est. time ~2 hours

Related links

How Suki supports this

  • Form Filling APIs let you create sessions, seed form template context, stream visit audio on the Partner WebSocket, end capture, and retrieve structured output.
  • Form templates define the medical forms in scope for the visit through form_template_id values and returned generated_values.

Implementation checklist

  1. Read the Form filling overview to confirm the workflow generates structured form output, not ambient clinical notes.
  2. Choose where your product will manage recording, template selection, review, and save logic.
  3. Follow Basic usage to create a session, seed context, stream audio, end capture, and retrieve structured data.

What to read next

Start with the Form filling overview, then follow Basic usage and the Form Filling API reference for the exact session and structured-data contracts.

` }} />

All use cases

Form filling Template-driven form sessions

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

Form Filling APIsTemplates
Form Filling APIs Templates

Select Suki medical form templates, seed them into session context, and retrieve generated form values when processing completes.

You decide which forms are in scope for the visit by sending template metadata in session context. Suki uses the visit audio and selected templates to return structured values for the forms your workflow needs.

Use this integration when your product must support known form types, such as intake, nursing, assessment, or medication review forms, and each workflow needs a predictable set of returned fields.

Level Medium Est. time ~2 hours

Related links

How Suki supports this

  • Form Filling APIs let you create a session and seed context with form_template_id values.
  • Template APIs let you inspect supported medical form templates before your product starts a workflow.
  • Structured data retrieval returns generated and non-generated values after processing completes.

Implementation checklist

  1. List the Suki medical form templates available for your integration.
  2. Create a Form filling session and save the returned Form filling ambient_session_id.
  3. Seed or update context with the form_template_id values selected for the visit.
  4. Retrieve structured data and map returned values into your review or save workflow.

What to read next

Read Form Filling basic usage, then open the template and session context references while you design template selection in your product.

` }} />
Form filling Structured form output and EHR handoff

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

Form Filling APIsStructured data
Form Filling APIs Structured data

Poll status or use configured notifications, retrieve generated form values, and route structured output into your downstream workflow.

You control what happens after capture ends. Suki returns structured form output, and your product decides how clinicians review, edit, approve, save, or hand off the values.

Use this integration when your main product requirement is reliable downstream routing, for example saving fields into an EHR, handing off data to care management tools, or showing a review screen before final submission.

Level Medium Est. time ~2 hours

Related links

How Suki supports this

  • Status APIs let you poll processing state after the session ends.
  • Structured data APIs return generated and non-generated values for the templates in scope.
  • Webhooks can notify your application when completion events are configured for your partner account.

Implementation checklist

  1. End the Form filling session after capture completes.
  2. Poll session status or handle partner webhook completion events when configured.
  3. Retrieve structured data and map generated_values into your review or persistence model.
  4. Handle non_generated_values in your UI or downstream workflow.

What to read next

Use the status and structured data references while you design your review state, error handling, and EHR handoff behavior.

` }} />
Ambient Problem-based charting and structured note content

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

Web SDKHeadless Web SDKAmbient APIs
Web SDK Headless Web SDK Ambient APIs

Send problem-oriented structure so generated notes match diagnoses, sections, and visit-aware titles in your chart, using the Suki developer platform.

You supply diagnoses, visit-aware titles, sections, and related structure. Ambient capture still feeds the Suki Platform; returned documentation follows how clinicians chart in your product.

Use this integration when a plain transcript is not enough. The same ambient pipeline applies, with extra hooks and payloads in the Web SDK guide and the Ambient API capability reference.

Level Advanced Est. time ~3 hours

Related links

How Suki supports this

  • Web SDK and Headless Web SDK guides describe UI and hook patterns for problem-based charting flows.
  • Ambient APIs publish capability-oriented contracts for structured content and for orchestration behind your UI.

Implementation checklist

  1. Read the Web SDK problem-based charting guide for integration expectations and UI considerations.
  2. Cross-check fields and semantics in the problem-based charting capability reference.
  3. Validate session lifecycle and payloads for your ambient path (SDK or API) against the linked ambient guides.

What to read next

Stay with the problem-based charting guide until your payloads match the capability reference, then use the Ambient API overview and webhooks or content retrieval docs as needed for your rollout.

` }} />
Ambient Medication orders and richer session context

Enrich sessions so drafts reflect medication orders and chart context.

Ambient APIsMobile SDK
Ambient APIs Mobile SDK

Attach medication orders and EMR metadata to sessions so drafts align with the chart clinicians already use, using the Suki developer platform.

You send medication orders and related metadata with the ambient session. Generated notes reflect the same clinical frame as the live chart.

Use this integration when ordering context must ride alongside ambient capture. This documentation explains how to supply that context through Ambient APIs and how native capture fits when iOS owns the microphone through the Mobile SDK.

Level Advanced Est. time ~2 hours

Related links

How Suki supports this

  • Ambient APIs accept structured payloads tied to medication orders. The medication orders guide and related API reference pages describe fields and sequencing.
  • Mobile SDK documents native hooks when iOS hosts ambient capture next to your enrichment pipeline.

Implementation checklist

  1. Read the medication orders guide end to end before you change production payloads.
  2. Align REST sequencing with your ambient session lifecycle using the Ambient API overview and quickstart.
  3. For native iOS capture, verify Mobile SDK session responsibilities against the Mobile SDK overview.

What to read next

Finish the medication orders guide, then open each referenced endpoint in the API reference so your server sends the payloads this documentation describes.

` }} />
Ambient Session audio for playback or download

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

Ambient APIs
Ambient APIs

Request time-limited access to session audio for replay, audit, or archival jobs on the server, using the Suki developer platform.

You run authenticated backend services that request short-lived access to session recordings. Your organization replays, audits, or archives audio that matches generated ambient documentation.

Use this integration when retrieval must stay on the server. Follow Ambient APIs as described in the audio streaming and download guide. Do not expose long-lived media URLs to the browser.

Level Medium Est. time ~1 hour

Related links

How Suki supports this

  • Ambient APIs document recording retrieval, including short-lived URL patterns, in the audio streaming and download guide and related API reference pages.

Implementation checklist

  1. Read the audio streaming and download guide for supported flows and constraints.
  2. Run retrieval only in services that authenticate the same way as your other Ambient API callers.
  3. If you ingest live audio, review the streaming guides under Documentation, Media & integration.

What to read next

Follow the audio streaming and download guide into the cited endpoints, then finish security review with your internal compliance stakeholders.

` }} />
Ambient Webhooks and asynchronous session completion

Receive HTTPS callbacks when ambient sessions complete or fail.

WebhooksAmbient APIs
Webhooks Ambient APIs

Receive HTTPS callbacks when ambient sessions complete or fail so your servers update state without polling handsets, using the Suki developer platform.

You register a callback URL. The platform posts to your endpoint when sessions finish or error so downstream jobs run on your timeline.

Use this integration when you want push-driven completion instead of polling. The webhook guide covers POST delivery, signature verification with your partner secret, and how SDK integrations still use the same Ambient APIs underneath.

Level Medium Est. time ~1 hour

Related links

How Suki supports this

  • Notification webhooks document setup and verification, including headers such as generated-at and X-API-Key for HMAC validation.
  • Ambient APIs define session lifecycle before webhook delivery.

Implementation checklist

  1. Implement signature verification exactly as the webhook guide describes (raw body plus timestamp concatenation).
  2. Expose only TLS endpoints that your onboarding contacts confirm are reachable from Suki infrastructure.
  3. Exercise end-to-end flows with Ambient API quickstart session calls and your webhook handler.

What to read next

Finish the webhook guide, then align payloads with the ambient session objects your integration stores.

` }} />
Dictation Hosted browser dictation for fields and scratchpads

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

Dictation SDKJavaScriptReact
Dictation SDK JavaScript React

Add hosted speech-to-text to a browser application with in-field and scratchpad modes while your product controls launch points, callbacks, and where transcript text goes.

You use the Dictation SDK for browser dictation through JavaScript or React. Suki hosts the dictation surface, and your application decides when to open it, which field or region it belongs to, and how submitted text updates your workflow.

Use this integration when clinicians need to dictate into a note field, form field, or scratchpad without your team managing REST sessions and WebSocket streaming directly. This path is separate from Headless Web SDK ambient hooks and from direct Dictation API integrations.

Level Medium Est. time ~2 hours

Related links

How Suki supports this

  • Dictation SDK provides JavaScript and React packages for hosted browser dictation.
  • In-field mode ties dictation to a specific text field or editor through your configured host element and callbacks.
  • Scratchpad mode opens dictation in a standalone area when users need to capture text before applying it elsewhere.

Implementation checklist

  1. Read the Dictation SDK introduction and confirm package, authentication, and iframe requirements.
  2. Choose in-field mode when dictation should attach to one field, or scratchpad mode when dictation needs its own area.
  3. Wire callbacks so submitted transcript text updates the correct field, editor, or downstream state in your product.

What to read next

Start with the Dictation SDK introduction, then read in-field mode or scratchpad mode based on the browser experience you want to ship.

` }} />
Dictation API-driven real-time dictation without hosted UI

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

Dictation APIsWebSocket
Dictation APIs WebSocket

Build speech-to-text into your own client or backend flow by creating transcription sessions with REST APIs and streaming audio over the dictation WebSocket.

You own session creation, audio capture, transcript handling, and downstream text placement. Dictation APIs provide the REST session lifecycle and WebSocket streaming contract instead of a hosted browser UI.

Use this integration when capture runs in a backend service, desktop shell, device gateway, or custom client where your team needs direct control over audio streaming and transcript handling.

Level Advanced Est. time ~3 hours

Related links

How Suki supports this

  • Dictation APIs document session creation, streaming, and teardown in the API reference.
  • Dictation audio streaming describes the JSON WebSocket framing, audioData payloads, AUDIO_END, and inbound transcript frames you must handle after a session exists.

Implementation checklist

  1. Read Dictation Basic Usage to understand the REST and WebSocket workflow.
  2. Create a transcription session and save the transcription_session_id.
  3. Open /ws/transcribe only when the session is ready to accept speech, then send JSON AUDIO messages with Base64-encoded PCM audio.
  4. Render or store partial and final transcripts, send AUDIO_END, and end the session through the REST API.

What to read next

Start with Dictation Basic Usage, then use Dictation Audio Streaming and the API reference while you implement the WebSocket and transcript handling path.

` }} />
Ambient Telehealth and shared browser audio capture

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

Web SDK
Web SDK

Capture ambient audio in browser telehealth and shared-audio setups with Web SDK guidance on permissions and UX, using the Suki developer platform.

You keep clinicians in browser-based telehealth while the Web SDK handles capture patterns for that environment, including shared tab audio where supported.

Use this integration when vendor portals, browser prompts, and recovery flows interact tightly. Follow the telehealth and session recovery guides instead of assuming desktop microphone behavior.

Level Advanced Est. time ~2 hours

Related links

How Suki supports this

  • Web SDK telehealth guide covers supported capture scenarios.
  • Ambient session recovery describes resilience when users navigate away mid-session.

Implementation checklist

  1. Implement flows from the telehealth guide before you customize chrome.
  2. Add recovery UX from the ambient session recovery guide for navigation edge cases.
  3. Run QA with each telehealth vendor’s permission model; policies sit outside Suki documentation.

What to read next

Finish the telehealth guide checklist, then run vendor-specific QA on browser policies.

` }} />
Ambient Fully custom ambient UI with React hooks

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

Headless Web SDKReactBeta
Headless Web SDK React Beta

Compose ambient flows in React 18+ with @suki-sdk/platform-react hooks while you own the full UI, using the Suki developer platform.

You use hooks for authentication, ambient sessions, recording lifecycle, and related behaviors. You implement prompts, accessibility, and error handling that the headed Web SDK widget otherwise provides.

Use this integration when you cannot embed headed Web SDK UI but still need ambient in the browser. This beta surface is separate from the headed Web SDK. Plan staffing for offline and connectivity UX described in the Headless guides.

Level Advanced Est. time ~4 hours

Related links

  • Headless Web SDK introduction Beta scope and package entry points.
  • Quickstart Initial wiring steps.
  • Hook guides (/headless-web-sdk/guides/hooks/) Auth, ambient session, and related hook references.

How Suki supports this

  • Headless Web SDK introduction, quickstart, and hook guides list supported hooks and beta expectations.
  • Offline behavior guides state constraints you handle in React.

Implementation checklist

  1. Confirm beta approval and package versions from the Headless Web SDK introduction.
  2. Finish the quickstart, then wire hooks under SDKs, Headless Web SDK, Hooks.
  3. Read the offline mode guide if clinicians can lose connectivity mid-session.

What to read next

Complete quickstart, read each hook you plan to ship, then compare gaps with the headed Web SDK feature list and your solutions consultant.

` }} />
Ambient Note sections and structured documentation outputs

Shape generated notes into predictable sections for downstream systems.

Web SDKAmbient APIs
Web SDK Ambient APIs

Shape generated notes into sections, headings, and structured fields so downstream systems receive predictable layouts, using the Suki developer platform.

You configure how ambient output splits so EHR or specialty workflows consume repeatable structure instead of a single unstructured block.

Use this integration when downstream systems need predictable note shape. The note sections documentation explains how to reason about outputs during ambient integration. Specialties and multilingual material linked from Core workflows add constraints some programs must apply.

Level Medium Est. time ~1 hour

Related links

How Suki supports this

  • Note sections and Specialties hub pages explain concepts and links in this documentation set.
  • Web SDK and Ambient APIs are the implementation surfaces after you understand section semantics.

Implementation checklist

  1. Read the note sections guide before you change generation templates.
  2. Read the specialties hub when your rollout includes specialty-specific behavior documented there.
  3. Return to your ambient integration guide (Web SDK or API) to apply those concepts in code.

What to read next

Read note sections and specialties first, then schedule engineering work against the ambient integration surface you already selected.

` }} />
Dictation Choose the right dictation integration path

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

Dictation APIsDictation SDK
Dictation APIs Dictation SDK

Compare the supported speech-to-text paths: direct Dictation APIs, Web SDK browser dictation, and Dictation SDK hosted iframe workflows.

You use the Audio Dictation guide to decide who owns capture, session lifecycle, transcript handling, and user experience. The guide separates direct REST and WebSocket integrations from browser SDK options.

Use this integration when product and engineering teams need to choose between full API control, Web SDK browser components, or Dictation SDK in-field and scratchpad modes before implementation begins.

Level Medium Est. time ~2 hours

Related links

How Suki supports this

  • Audio Dictation explains when to choose Partner APIs, Web SDK, or Dictation SDK.
  • Dictation APIs provide direct REST and WebSocket control for custom clients.
  • Dictation SDK provides hosted browser dictation for in-field and scratchpad experiences.

Implementation checklist

  1. Read the Audio Dictation guide and map your scenario to Partner APIs, Web SDK, or Dictation SDK.
  2. Choose Partner APIs when your backend or custom client owns session lifecycle and streaming.
  3. Choose Dictation SDK when your browser app needs hosted in-field or scratchpad dictation.

What to read next

Use the Audio Dictation guide as the decision point, then continue to the API, Web SDK, or Dictation SDK path that matches your product.

` }} />
Dictation Real-time dictation streaming over WebSocket

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

WebSocketDictation APIs
WebSocket Dictation APIs

Stream dictation audio as JSON text frames on GET /ws/transcribe after you create a transcription session with REST.

You follow a protocol that uses UTF-8 JSON frames, one object per frame, Base64-encoded PCM_S16LE in audioData, and an EVENT message with AUDIO_END when audio completes. Treat these rules as part of the integration contract.

Use this integration when you implement a custom WebSocket client and need to render or store partial and final transcripts yourself. Follow the handshake and message ordering rules before you ship a custom client.

Level Advanced Est. time ~2 hours

Related links

How Suki supports this

  • Dictation audio streaming explains transport, message structure, session state rules, and inbound transcript frames.
  • Stream audio to dictation session provides endpoint details and code examples.

Implementation checklist

  1. Create a transcription session and save the transcription_session_id.
  2. Open the WebSocket when the session is ready to accept speech.
  3. Send one JSON object per frame, use audioData, and finish each stream with AUDIO_END.
  4. Handle partial, final, and end-of-results transcript messages from the server.

What to read next

Keep Dictation Audio Streaming open while you implement transport behavior, then cross-check the endpoint reference for code examples and connection details.

` }} />
Ambient Offline-capable ambient capture (React)

Plan ambient capture for brief connectivity loss in React.

Headless Web SDKReact
Headless Web SDK React

Plan for brief connectivity loss so clinicians recover or sync ambient sessions without data loss in Headless React apps, using the Suki developer platform.

You own prompts, retries, and reconciliation. Headless integrations expose hooks; the offline-mode and online and offline behavior guides describe what your team must implement.

Use this integration when you deploy on unreliable Wi-Fi or cellular networks. Offline support is not automatic. Read the guides before you promise uninterrupted capture on poor networks.

Level Advanced Est. time ~2 hours

Related links

How Suki supports this

  • Offline mode guide states ambient capture constraints.
  • Online and offline behavior explains state transitions you must honor.

Implementation checklist

  1. Read the offline mode guide before you promise uninterrupted capture.
  2. Align in-product messaging with the online and offline behavior guide.
  3. Verify hooks against Headless quickstart examples.

What to read next

Prototype offline scenarios in staging with the guides above, then document recovery copy for compliance review.

` }} />
Ambient Compact ambient UI with minimized layout

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

Web SDK
Web SDK

Run ambient capture in a compact Web SDK footprint when space or vendor overlays block full chrome, using the Suki developer platform.

You keep the headed Web SDK with a smaller surface through minimized layout. Documentation lists embedding constraints, dialogs, and implementation notes for the compact UI.

Use this integration when EHR frames or overlays leave little room for full chrome. Authentication and session responsibilities match the broader Web SDK guides.

Level Medium Est. time ~1 hour

Related links

How Suki supports this

  • Minimized layout overview anchors the compact UX subtree.
  • The implementation guide linked from that overview covers integration specifics.

Implementation checklist

  1. Read the minimized layout overview for eligibility constraints.
  2. Follow the implementation guide linked from that page before UX sign-off.
  3. Regression-test with telehealth guide scenarios when both apply.

What to read next

Finish the minimized layout checklist, then review UX against real vendor iframe dimensions.

` }} />
Ambient Personalization and preference-aware ambient behavior

Send personalization payloads so generation honors provider and organization settings.

Ambient APIs
Ambient APIs

Send personalization payloads so ambient generation honors provider- and organization-level settings, using the Suki developer platform.

You map preference payloads to the personalization capability in the API reference. Sessions consume the fields you attach at creation or update.

Use this integration when end-user or org-level tuning must reach server-side generation. Field lists, enums, and coupling to session creation live in the personalization capability reference. This card does not duplicate schemas that change between releases.

Level Medium Est. time ~1 hour

Related links

How Suki supports this

  • Personalization capability reference defines payload semantics.
  • Ambient session APIs on that page show where preferences attach during creation or updates.

Implementation checklist

  1. Open the personalization capability reference and list the fields your EMR can supply.
  2. Validate ordering against ambient session creation flows in the API reference.
  3. Monitor rejected payloads with your existing API observability tools.

What to read next

Keep the capability reference open during implementation. Clinical governance owns business-specific tuning policies.

` }} />
Form filling Choose the Form Filling API path

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

Form Filling APIsGuide
Form Filling APIs Guide

Confirm how your team will own UI, audio handling, session lifecycle, and structured-data handoff before building a Form Filling API integration.

You use the integration decision guide to map your product type, team skills, and technical requirements to the Form Filling API workflow.

Use this integration when architecture, product, and delivery teams need to align before implementation. The guide explains how Form Filling APIs apply across web applications, mobile applications, backend systems, and multi-platform products.

Level Easy Est. time ~30 minutes

Related links

How Suki supports this

  • Form filling integration decision guide explains the API path and ownership model.
  • Form filling overview defines the workflow and links to Basic usage.
  • Form Filling API reference provides endpoint-level contracts after the path is selected.

Implementation checklist

  1. Read the Form filling overview to understand scope and terminology.
  2. Use the integration decision guide to confirm client, backend, and UI responsibilities.
  3. Open the Form Filling API reference before sprint planning so estimates reflect the actual contracts.

What to read next

Share the decision guide with product, engineering, and security stakeholders, then move into Basic usage when the API path is confirmed.

` }} />

Partner case studies and press