Direct Mode Client

Before you start

Copy the App ID and API Key from Apps and the Avatar ID from the Avatar Library. Keep the API Key on your backend and send the client only the App ID, Avatar ID, and a short-lived Session Token.

Choose your client

Every client follows the same path: initialize Direct Mode and set the Session Token → load and mount the Avatar → connect and send avatar speech audio → close and dispose.

Web
iOS
Android
Flutter

Install AvatarKit:

npm install @spatius/avatarkit

Configure the WebAssembly assets for Vite or Next.js before initializing the SDK.Web demo · Web SDK Reference

Install AvatarKit with Swift Package Manager, CocoaPods, or AvatarKit.xcframework. See iOS installation.iOS demo · iOS SDK Reference

Add AvatarKit to build.gradle.kts:

dependencies {
    implementation("ai.spatius:avatarkit:1.3.3")
}

Android demo · Android SDK Reference

Add AvatarKit to pubspec.yaml:

dependencies:
  spatius_avatarkit: ^1.3.3

Start Here

Quickstarts

Integrations

Concepts

Examples & Support

Direct Mode Client

Before you start

Choose your client

Next steps

Session Token auth

Audio

Demo projects

​Before you start

​Choose your client

​Next steps

Session Token auth

Audio

Demo projects

Before you start

Choose your client

Next steps