General

General questions about the Suki Form filling SDK

What Is the Suki Form Filling SDK?

A headed JavaScript and React library that embeds Form filling in a hosted iframe. Clinicians fill medical forms by voice; your app receives structured JSON through callbacks and webhooks. See the Form filling SDK glossary entry for a short definition.

Refer to the Introduction.

Is the Form Filling SDK Headless?

No. The Form filling SDK is a headed SDK. It opens Suki’s hosted iframe UI in your page.

For Form filling without a hosted iframe, use the Form filling API.

What Is the Difference Between the Form Filling SDK and the Form Filling API?

Form filling SDK: Headed browser SDK. Embed Form filling in a hosted iframe. Suki hosts the UI and returns structured data through onSubmit and your webhook.

Form filling API: Call Suki REST and WebSocket APIs from your own code without the hosted SDK. Refer to Form filling API.

Which Npm Packages Should I Install?

Install the Form filling SDK with @suki-sdk/core:

• JavaScript: @suki-sdk/form-filling + @suki-sdk/core.
• React: @suki-sdk/form-filling-react + @suki-sdk/core.

Refer to Installation.

How Does Form Filling SDK Differ from Dictation SDK?

Dictation SDK returns free-text transcripts.

Form filling SDK returns structured medical form JSON for Suki templates and partner-defined schemas. Prefer forms. form_template_ids still works for static-only sessions when forms is omitted.

Refer to Dictation SDK Overview.

Does the Form Filling SDK Run on the Server?

No. Use it in a browser with a sized container and microphone access. Refer to Prerequisites.