Home Page - Suki

Form Filling APIs

REST

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

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

View API Reference →

Ambient APIs
Mobile SDK
Web SDK
Headless Web SDK

RESTWebSocketWebhooks

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

View API Reference →

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.

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

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 →

Diagram: form template, form filling session, and structured field output

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

Diagram: headed Web SDK with pre-built UI

Diagram: headless React SDK and custom UI

Diagram: microphone audio streaming through a dictation API to a live transcript

Diagram: browser with embedded Dictation SDK microphone producing a transcript

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