Suki for Partners developer documentation hero illustration

Start building
with Suki for Partners

Find the guides, how-tos, tutorials, APIs, and SDKs to integrate Suki’s Ambient Clinical Intelligence into your product and move from zero to production-ready in days, not months.

Start building

Quickstart

Use this quickstart to run your first Suki integration. Onboard with Suki to receive your Partner ID.

Explore Use Cases

Understand various use cases and workflows that Suki supports. Learn how to build your desired feature into your product.

What are you building?

Pick your workflows

Start with one or a combination of the workflows that matches your use case and technical approach.

Form Filling APIs
Form Filling SDK
Web SDK

REST

Form filling APIs allow you to create, update, and retrieve Form filling sessions.

View API Reference →

BetaReactJavaScript

Form filling SDK allows you to embed Form filling in the browser with a hosted iframe or React components.

npm install @suki-sdk/form-filling-react

View Form filling SDK Docs →

ReactJavaScript

Web SDK allows you to run Form filling from the headed Web SDK packages without a standalone Form filling SDK install.

npm install @suki-sdk/react

View Web SDK Form filling Docs →

Ambient APIs
Mobile SDK
Web SDK
Headless Web SDK

RESTWebSocketWebhooks

Ambient APIs allow you to create, update, and retrieve ambient sessions.

View API Reference →

Ambient workflows are .

iOSSwift

Mobile SDK allows you to create, update, and retrieve ambient sessions on iOS devices.

// Add SukiAmbientCore.framework to your Xcode project
import SukiAmbientCore.framework

View Mobile SDK Docs →

ReactJavaScript

Web SDK allows you to create, update, and retrieve ambient sessions with the pre-built UI components.

npm install @suki-sdk/react

View Web SDK Docs →

ReactHeadless

Headless Web SDK allows you to create, update, and retrieve ambient sessions in the browser without the pre-built UI.

npm install @suki-sdk/platform-react

View Headless SDK Docs →

Dictation APIs
Dictation SDK
Web SDK

RESTWebSocket

Dictation APIs allow you to create, stream audio, and receive live transcripts from audio Dictation sessions.

View API Reference →

BetaReactJavaScript

Dictation SDK allows you to embed Dictation in the browser with a hosted iframe or React components.

npm install @suki-sdk/dictation-react

View Dictation SDK Docs →

ReactJavaScript

Web SDK allows you to add in-field or scratchpad Dictation from the headed Web SDK packages without a standalone Dictation SDK install.

npm install @suki-sdk/react

View Web SDK Dictation Docs →

Patient Summary APIs
Web SDK

REST

Patient Summary APIs allow you to ingest FHIR data, generate, and retrieve Patient summaries.

View API Reference →

ReactJavaScript

Web SDK allows you to show Patient Summary on the headed patient profile from v3.3.0 without calling generate or retrieve APIs.

npm install @suki-sdk/react

View Web SDK Patient Summary Docs →

curl --request GET \
  --url https://sdp.suki-stage.com/api/v1/form-filling/session/{ambient_session_id}/status \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>'

import { FormFillingClient } from "@suki-sdk/form-filling-react";

const client = new FormFillingClient({ authManager });

client.start({
  form_template_ids: ["<template_id>"],
  correlation_id: "<encounter_id>",
  onSubmit: (result) => console.log(result),
});

import { FormFillingClient } from "@suki-sdk/react";

const client = new FormFillingClient({ authManager });

client.start({
  form_template_ids: ["<template_id>"],
  correlation_id: "<encounter_id>",
  onSubmit: (result) => console.log(result),
});

const sessionId = '{ambient_session_id}';
const res = await fetch(
  `https://sdp.suki-stage.com/api/v1/ambient/session/${sessionId}/status`,
  { headers: { sdp_suki_token: '<sdp_suki_token>', sdp_provider_id: '<sdp_provider_id>' } }
);
console.log(res.status, await res.json());

import requests

session_id = "{ambient_session_id}"
url = f"https://sdp.suki-stage.com/api/v1/ambient/session/{session_id}/status"
headers = {"sdp_suki_token": "<sdp_suki_token>", "sdp_provider_id": "<sdp_provider_id>"}
r = requests.get(url, headers=headers)
print(r.status_code, r.json())

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://sdp.suki-stage.com/api/v1/ambient/session/{ambient_session_id}/status"
	req, _ := http.NewRequest(http.MethodGet, url, nil)
	req.Header.Set("sdp_suki_token", "<sdp_suki_token>")
	req.Header.Set("sdp_provider_id", "<sdp_provider_id>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(b))
}

require "net/http"

uri = URI("https://sdp.suki-stage.com/api/v1/ambient/session/{ambient_session_id}/status")
req = Net::HTTP::Get.new(uri)
req["sdp_suki_token"] = "<sdp_suki_token>"
req["sdp_provider_id"] = "<sdp_provider_id>"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.code
puts res.body

curl --request GET \
  --url https://sdp.suki-stage.com/api/v1/ambient/session/{ambient_session_id}/status \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>'

let sessionInfo = [
    SukiAmbientConstant.kEmrEncounterId: "<emr_encounter_id>"
] as [String: AnyHashable]

SukiAmbientCoreManager.shared.createSession(with: sessionInfo, onCompletion: { result in
    if case .success(let response) = result {
        print(response.sessionId)
    }
})

import { SukiAssistant } from "@suki-sdk/react";

<SukiAssistant
  encounter={currentEncounter}
  onNoteSubmit={handleNoteSubmit}
/>

import { useAmbient } from "@suki-sdk/platform-react";

const { ambientSessionId, session } = useAmbient();

return (
  <button onClick={() => session.create({ encounterId: 'your-encounter-id' })}>
    Create ambient session
  </button>
);

curl --request POST \
  --url https://sdp.suki-stage.com/api/v1/transcription/session/create \
  --header 'Content-Type: application/json' \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>'

import { DictationClient } from "@suki-sdk/dictation";

const client = new DictationClient({ authManager });

client.show({
  mode: "in-field",
  fieldId: "assessment",
  rootElement: document.getElementById("dictation-root"),
  onSubmit: ({ text }) => saveText(text),
});

import { DictationClient } from "@suki-sdk/react";

const client = new DictationClient({ authManager });

client.show({
  mode: "in-field",
  fieldId: "assessment",
  rootElement: document.getElementById("dictation-root"),
  onSubmit: ({ text }) => saveText(text),
});

curl --request POST \
  --url https://sdp.suki-stage.com/api/v1/patient-summary/generate/encounter \
  --header 'Content-Type: application/json' \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>' \
  --data '{
    "fhir_encounter_id": "<fhir_encounter_id>",
    "fhir_practitioner_id": "<fhir_practitioner_id>"
  }'

init({
  authManager,
  encounter: {
    identifier: "<fhir_encounter_id>",
    practitionerFhirId: "<fhir_practitioner_id>",
  },
});

<SukiAssistant
  encounter={{
    identifier: "<fhir_encounter_id>",
    practitionerFhirId: "<fhir_practitioner_id>",
  }}
/>