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.

With Suki for Partners, you can create Ambient, Dictation, and Form Filling workflows. Choose the APIs or SDKs integration paths that best fit your application type, stack, and how much user interface you want to own.

Choose your integration path

Ambient Workflows & Use Cases

Use ambient workflows to add ambient clinical intelligence to your application for doctor-patient conversations.

Ambient APIs

REST | WebSocket | Webhooks

Web SDK

JavaScript | React | Headed

Mobile SDK

iOS | Swift

Headless Web SDK

React | Headless

Dictation SDK

JavaScript | React

Form Filling Workflows & Use Cases

Use form filling workflows for ambient clinical documentation for nursing and other clinical workflows.

Form Filling REST APIs

REST | WebSocket | Webhooks

What should I use?

AreaDirect API calls (REST/WebSocket/Webhooks)SDKs (Web SDK, Headless Web SDK, Mobile SDK, Dictation SDK)
AuthenticationBuild token exchange, storage, headers, and refresh logic.SDK-managed auth setup and token use.
Session lifecycleCall create, update, status, and end endpoints directly.SDK methods or hooks for common session actions.
Audio streamingManage WebSocket connections, audio chunks, events, and reconnects.Managed recording, streaming, and session events.
UIBuild every screen, control, and workflow state.Web SDK includes UI; Headless Web SDK, Mobile SDK, and Dictation SDK handle integration behavior.
Type safetyValidate request and response data in your code.Typed methods, options, and events.
Error handlingParse HTTP status codes, error bodies, and WebSocket failures.SDK errors and events expose structured failure details.
Platform fitAny client, backend, or multi-platform architecture.Supported web, React, iOS, and dictation workflows.
ControlMaximum control over protocol behavior.Less protocol code for supported integrations.
Last modified on May 22, 2026