> ## 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 Dictation SDK

> Add In-field or Scratchpad Dictation to your web app with Suki's hosted iframe UI for JavaScript and React

The Suki Dictation SDK is a JavaScript and React library that lets you add Dictation to your web application using Suki's hosted iframe UI. Instead of building the Dictation experience yourself, you embed the SDK and integrate it with your application's fields and workflows.

Your application initializes the SDK, authenticates with `SukiAuthManager`, and handles transcript callbacks. The SDK provides the hosted Dictation UI, while your application controls how final transcripts update chart fields or other UI.

<Callout icon="handshake" color="orange">
  **Are you a Suki partner?**

  To use any Suki API or SDK, you must be a Suki partner. Contact the partnership team to begin the onboarding process. They help you set up your authentication system and get started with the Suki APIs and SDKs.

  <div style={{ marginTop: '0.75rem' }}>
    <a className="doc-guide-btn partner-contact-cta" href="https://www.suki.ai/suki-partners/" target="_blank" rel="noopener noreferrer">
      Contact Partnership Team
    </a>
  </div>
</Callout>

<Info>
  If your integration uses Suki's Web SDK, Dictation is **already included** in the Web SDK. Install the standalone Dictation packages only when you want Dictation without the rest of the Web SDK.
</Info>

## Get started

Confirm requirements, install the SDK, authenticate, and run your first Dictation session.

<Columns cols={3}>
  <Card title="Introduction" icon="book" href="/dictation-sdk/introduction" arrow={true}>
    <p>Learn how the Dictation SDK works and when to use it in your application</p>
  </Card>

  <Card title="Prerequisites" icon="list-check" href="/dictation-sdk/prerequisites" arrow={true}>
    <p>Confirm Partner credentials and setup requirements before you install</p>
  </Card>

  <Card title="Install the SDK" icon="download" href="/dictation-sdk/installation" arrow={true}>
    <p>Install the JavaScript or React Dictation packages</p>
  </Card>

  <Card title="Authenticate" icon="key" href="/dictation-sdk/guides/authentication" arrow={true}>
    <p>Learn how `SukiAuthManager` authenticates Dictation SDK sessions</p>
  </Card>

  <Card title="Run Your First Session" icon="rocket" href="/dictation-sdk/quickstart" arrow={true}>
    <p>Initialize, authenticate, and start a Dictation session end to end</p>
  </Card>
</Columns>

## Choose a Dictation mode

Pick the hosted Dictation experience that fits your UI. Use In-field mode for a target input. Use Scratchpad mode for a floating Dictation panel.

<Columns cols={3}>
  <Card title="In-Field Mode" icon="input-text" href="/dictation-sdk/guides/in-field-mode" arrow={true}>
    <p>Dictate directly into a target field in notes or forms</p>
  </Card>

  <Card title="Scratchpad Mode" icon="window" href="/dictation-sdk/guides/scratchpad-mode" arrow={true}>
    <p>Use a floating Dictation panel that is not tied to one input</p>
  </Card>
</Columns>

## Integrate Dictation

Embed the SDK in JavaScript or React, then wire architecture, callbacks, and configuration for how transcripts return to your application.

<Columns cols={3}>
  <Card title="JavaScript Integration" icon="js" href="/dictation-sdk/javaScript-integration/javaScript" arrow={true}>
    <p>Embed Dictation in vanilla JavaScript applications</p>
  </Card>

  <Card title="React Integration" icon="react" href="/dictation-sdk/react-integration/react" arrow={true}>
    <p>Embed Dictation in React applications</p>
  </Card>

  <Card title="Architecture" icon="sitemap" href="/dictation-sdk/guides/architecture" arrow={true}>
    <p>Learn how your application, the SDK, sign-in, and hosted Dictation fit together</p>
  </Card>

  <Card title="Callbacks" icon="bolt" href="/dictation-sdk/guides/callbacks" arrow={true}>
    <p>Handle transcripts and session events from the Dictation SDK</p>
  </Card>

  <Card title="Configuration" icon="sliders" href="/dictation-sdk/guides/configuration" arrow={true}>
    <p>Configure Dictation SDK options for your application</p>
  </Card>
</Columns>

## Resources

Use these pages when you need examples, tutorials, error handling, release notes, or partner support.

<Columns cols={3}>
  <Card title="Configuration Examples" icon="laptop-code" href="/dictation-sdk/guides/examples/configuration-examples" arrow={true}>
    <p>Browse Dictation SDK configuration examples for common setups</p>
  </Card>

  <Card title="Chart Field Tutorial" icon="graduation-cap" href="/documentation/tutorials/dictation-sdk-chart-field" arrow={true}>
    <p>Build Dictation into a chart field with the Dictation SDK</p>
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/dictation-sdk/guides/error-handling" arrow={true}>
    <p>Handle Dictation SDK errors during authentication and recording</p>
  </Card>

  <Card title="FAQs" icon="circle-question" href="/dictation-sdk/faqs/general" arrow={true}>
    <p>Find answers to general, integration, and technical questions</p>
  </Card>

  <Card title="Changelog" icon="clock-rotate-left" href="/dictation-sdk/changelog" arrow={true}>
    <p>Track Dictation SDK releases, enhancements, and breaking changes</p>
  </Card>

  <Card title="Support" icon="life-ring" href="/documentation/references/support" arrow={true}>
    <p>Contact Suki for partner documentation and SDK support</p>
  </Card>
</Columns>