Reference sections
| Section | What it contains | Use it when |
|---|---|---|
| Client SDKs | Web, iOS, Android, Flutter, and Web RTC Adapter reference pages. | You need AvatarKit classes, methods, callbacks, enums, rendering APIs, or client lifecycle details. |
| Server SDKs | Python, Go, and JavaScript / TypeScript SDK references. | Your backend connects to Motion Server in Backend Mode or a packaged integration runtime. |
| Session Token API | Console API pages for Session Token creation and Direct Mode auth flow. | Your backend mints short-lived Session Tokens for Direct Mode clients. |
| Regions & Endpoints | Supported region names and composed Console API / Motion Server endpoints. | Any integration needs a deployment region or endpoint reference. |
| Error handling | Client and server recovery guidance. | You are debugging failed sessions, asset loading, WebSocket connection, or Server SDK errors. |
Client SDK lookup
| Platform or package | Reference page | Main use |
|---|---|---|
Web @spatius/avatarkit | AvatarKit Web SDK Reference | Web AvatarKit initialization, loading, rendering, Direct Mode, Backend Mode client feed, state, enums, and errors. |
| Web toolchain | Toolchain Setup | Configure bundlers to serve AvatarKit WebAssembly assets correctly. |
Web RTC Adapter @spatius/avatarkit-rtc | RTC Adapter | Render avatar output from LiveKit or Agora RTC providers on Web. |
| iOS AvatarKit | iOS SDK Reference | Native iOS AvatarKit methods, enums, callbacks, and rendering controls. |
| Android AvatarKit | Android SDK Reference | Native Android AvatarKit methods, enums, callbacks, and rendering controls. |
Flutter spatius_avatarkit | Flutter SDK Reference | Flutter setup, Direct Mode, Backend Mode client feed, state callbacks, and demos. |
Server lookup
| Surface | Reference page | Main use |
|---|---|---|
| Python Server SDK | Python SDK | Backend Mode sessions, audio input, egress, encoded output callbacks, options, and errors. |
| Go Server SDK | Go SDK | Go Backend Mode sessions, audio input, egress, encoded output callbacks, options, and errors. |
| JavaScript Server SDK | JavaScript / TypeScript SDK | Node.js Backend Mode sessions, audio input, egress, encoded output callbacks, options, and errors. |
| Session Token API | Session Token API | Mint Direct Mode Session Tokens from your backend. |
| Auth Flow | Session Token Auth Flow | Understand how a Direct Mode client obtains and uses a Session Token. |
Shared lookup
| Need | Page |
|---|---|
| Which SDK supports which feature | SDK Capability Matrix |
| Region names and endpoint composition | Regions |
| Client errors | Client Error Handling |
| Server SDK errors | Server Error Handling |
| Demo repo by integration | Demo Matrix |