> ## 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.

# Integration Paths Overview

> Suki for Partners offers Ambient, Dictation, Form filling, and Patient Summary workflows. Learn more about each workflow and how to choose the right APIs or SDKs for your use case

With Suki for Partners, you can create Ambient, Dictation, Form filling, and Patient Summary 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

<Card title="Ambient & Dictation Workflows + Use Cases" icon="waveform">
  Use ambient workflows to add ambient clinical intelligence to your application for doctor-patient conversations.

  <CardGroup cols={2}>
    <Card title="Ambient APIs" icon="code" href="/documentation/get-started/integration-decision-guide#ambient-apis" arrow={true}>
      <Badge size="sm" color="blue" icon="code">REST</Badge> | <Badge size="sm" color="green" icon="globe">WebSocket</Badge> | <Badge size="sm" color="orange" icon="webhook">Webhooks</Badge>
    </Card>

    <Card title="Web SDK" icon="globe" href="/documentation/get-started/integration-decision-guide#web-sdk" arrow={true}>
      <Badge size="sm" color="blue" icon="code">JavaScript</Badge> | <Badge size="sm" color="green" icon="react">React</Badge> | <Badge size="sm" color="gray" icon="desktop">Headed</Badge>
    </Card>

    <Card title="Mobile SDK" icon="mobile" href="/documentation/get-started/integration-decision-guide#mobile-sdk" arrow={true}>
      <Badge size="sm" color="purple" icon="apple">iOS</Badge> | <Badge size="sm" color="orange" icon="swift">Swift</Badge>
    </Card>

    <Card title="Headless Web SDK" icon="react" href="/documentation/get-started/integration-decision-guide#headless-web-sdk" arrow={true}>
      <Badge size="sm" color="blue" icon="react">React</Badge> | <Badge size="sm" color="gray" icon="react">Headless</Badge>
    </Card>

    <Card title="Dictation SDK" icon="microphone" href="/documentation/get-started/integration-decision-guide#dictation-sdk" arrow={true}>
      <Badge size="sm" color="orange" icon="code">JavaScript</Badge> | <Badge size="sm" color="green" icon="react">React</Badge>
    </Card>
  </CardGroup>
</Card>

***

<Card title="Form Filling Workflows + Use Cases" icon="file-lines">
  Use Form filling workflows to capture visit conversation and populate structured medical forms in nursing and other clinical workflows.

  <CardGroup cols={2}>
    <Card title="Form Filling REST APIs" icon="code" href="/documentation/get-started/form-filling-integration-decision-guide#form-filling-apis" arrow={true}>
      <Badge size="sm" color="blue" icon="code">REST</Badge> | <Badge size="sm" color="green" icon="globe">WebSocket</Badge> | <Badge size="sm" color="orange" icon="webhook">Webhooks</Badge>
    </Card>

    <Card title="Form Filling SDK" icon="react" href="/documentation/get-started/form-filling-integration-decision-guide#form-filling-sdk" arrow={true}>
      <Badge size="sm" color="blue" icon="code">JavaScript</Badge> | <Badge size="sm" color="green" icon="react">React</Badge> | <Badge size="sm" color="gray" icon="desktop">Hosted</Badge>
    </Card>
  </CardGroup>
</Card>

***

<Card title="Patient Summary Workflows + Use Cases" icon="user">
  Use Patient Summary workflows to generate concise pre-visit overviews from FHIR data ingested into the Clinical Knowledge Graph (CKG).

  <CardGroup cols={2}>
    <Card title="Patient Summary APIs" icon="code" href="/documentation/get-started/patient-summary-integration-decision-guide#patient-summary-apis" arrow={true}>
      <Badge size="sm" color="blue" icon="code">REST</Badge> | <Badge size="sm" color="yellow" icon="database">CKG</Badge>
    </Card>
  </CardGroup>
</Card>

## What should I use to integrate Suki

The table below compares what you build yourself with direct API calls versus what the SDKs handle for you. Use it to decide how much of the integration you want to own.

| Area              | Direct API calls (REST, WebSocket, Webhooks)                            | SDKs (Web, Headless Web, Mobile, Dictation, Form filling)                                                                                                       |
| ----------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authentication    | You implement token exchange, storage, headers, and refresh logic.      | The SDK sets up authentication and applies your token for you.                                                                                                  |
| Session lifecycle | You call the create, update, status, and end endpoints directly.        | You use SDK methods or hooks for common session actions.                                                                                                        |
| Audio streaming   | You manage WebSocket connections, audio chunks, events, and reconnects. | The SDK manages recording, streaming, and session events.                                                                                                       |
| User interface    | You build every screen, control, and workflow state.                    | The Web SDK and Form filling SDK include a hosted UI. The Headless Web SDK, Mobile SDK, and Dictation SDK handle integration behavior while you own the layout. |
| Type safety       | You validate request and response data in your own code.                | You get typed methods, options, and events.                                                                                                                     |
| Error handling    | You parse HTTP status codes, error bodies, and WebSocket failures.      | The SDK surfaces structured failure details through errors and events.                                                                                          |
| Platform fit      | Works with any client, backend, or multi-platform architecture.         | Fits supported web, React, iOS, Dictation, and Form filling browser workflows.                                                                                  |
| Control           | Gives you maximum control over protocol behavior.                       | Requires less protocol code for supported integrations.                                                                                                         |

<span id="client-sdks-headed-and-headless" />

<Note>
  All Suki SDKs are <Tooltip tip="An SDK that runs on the end-user device, such as a browser or native mobile app, rather than on your backend server." cta="View in Glossary" href="/Glossary/c">Client SDKs</Tooltip>. They run in the clinician's browser or mobile app, where they handle authentication, capture audio, manage session state, and communicate with Suki over HTTPS or WebSockets.

  When choosing an SDK, the primary difference is whether Suki provides the user interface or whether you build it yourself.

  | SDK type               | Best for                                                                                                    | Suki products                            |
  | :--------------------- | :---------------------------------------------------------------------------------------------------------- | :--------------------------------------- |
  | **Headed** (hosted UI) | You want Suki to provide the clinical UI and user experience.                                               | Web SDK, Dictation SDK, Form Filling SDK |
  | **Headless**           | You want to build your own UI while using Suki for authentication, audio streaming, and session management. | Headless Web SDK, Mobile SDK             |
</Note>

<Tip>
  * Regardless of which SDK you use, your backend can call Suki REST APIs and receive webhooks for tasks such as session management, transcripts, notes, and structured data.
  * Client SDKs and backend APIs are designed to work together as part of the same integration.
  * For Patient Summary, integrate through REST APIs on your backend. There is no Patient Summary client SDK today.
</Tip>

## Related guides

<CardGroup cols={2}>
  <Card title="Ambient & Dictation Decision Guide" icon="list" href="/documentation/get-started/integration-decision-guide" arrow={true}>
    Compare the API and SDK paths for Ambient and Dictation, then pick the one that fits your stack and how much UI you want to own.
  </Card>

  <Card title="Form Filling Decision Guide" icon="shield-check" href="/documentation/get-started/form-filling-integration-decision-guide" arrow={true}>
    Compare the API and SDK paths for Form filling, then pick the one that fits your workflow and structured data needs.
  </Card>

  <Card title="Patient Summary Decision Guide" icon="user" href="/documentation/get-started/patient-summary-integration-decision-guide" arrow={true}>
    Decide how to integrate Patient Summary APIs for pre-visit schedule and chart workflows.
  </Card>

  <Card title="Partner Onboarding" icon="handshake" href="/documentation/get-started/partner-onboarding" arrow={true}>
    Register your organization with Suki, configure authentication, and get your Partner ID.
  </Card>

  <Card title="Available Workflows" icon="rocket" href="/documentation/concepts/core-workflows" arrow={true}>
    See the Ambient, Dictation, Form filling, and Patient Summary workflows Suki supports and what each one does.
  </Card>
</CardGroup>
