Skip to main content

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.

From Web SDK v3.0.0+: You need @suki-sdk/core for SukiAuthManager for authenticating the Suki Web SDK.

Overview

We have modularized the Suki Web SDK into framework-specific packages so you only need to install the one that fits your environment. The SDK is built for modern JavaScript and requires an ES6 compatible browser.

Prerequisites

For the rest of this documentation, we will assume you have completed the Partner onboarding process and that:
  • You have received your partnerId from Suki
  • Your partner configuration includes a valid JWKS endpoint
  • Your authentication token contains the correct user identifier (e.g., sub, email)

Install the package

For plain JavaScript

Use the @suki-sdk/js package for plain JavaScript projects or with frameworks like Vue, Angular, or Solid.js. This package provides the core SDK functionality without tying it to a specific UI library. To install the package, run one of the following commands:
# Removed in v3.0.0
# pnpm add @suki-sdk/js
# New in v3.0.0
pnpm add @suki-sdk/js @suki-sdk/core

For React

For React applications, you should use the @suki-sdk/react package. It includes React-specific hooks and components that make it easy to integrate Suki’s functionality into your application. To install the package, run one of the following commands:
# Removed in v3.0.0
# pnpm add @suki-sdk/react
# New in v3.0.0
pnpm add @suki-sdk/react @suki-sdk/core
Web SDK v3: You need @suki-sdk/core for SukiAuthManager. See Migrating to Web SDK v3 if you are upgrading from v2.

Next steps

Read the Quickstart guide to get started with the Suki SDK.
Last modified on April 21, 2026