Suki for Partners developer documentation hero illustration

Start building
with Suki for Partners

Welcome to the Suki developer documentation. Find docs and resources to integrate Suki’s Ambient Clinical Intelligence into your product. Go from zero to production-ready integrations in days, not months.

Start Building Explore Use Cases

Pick your workflow

Start with the workflow that matches your use case and technical approach.

Form Filling APIs
Form Filling 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 →

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

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 →

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),
});

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()}>
    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),
});

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>"
  }'

Explore the popular docs

Start here

Explore documentation on common use cases and integration paths.

Platform Overview: Suki APIs and SDKs power Ambient, Dictation and Documentation intelligence across your application

Seamless Integration: integrate in minutes with simple APIs and SDKs. Built for speed, designed for flexibility

Developer Journey: from quickstart to production, we support you every step of the way

Get Started

Concepts & Feature Guides

Tutorials

Resources

FAQs & Support

Start building
with Suki for Partners

Pick your workflow

Start here

What’s new

Start buildingwith Suki for Partners

Pick your workflow

Start here

What’s new

Start building
with Suki for Partners