Skip to main content
This page is the shortest way to understand how the Spatius developer docs are organized. It is written for both developers and AI agents that need to find the right page before answering an implementation question.

What Spatius does

Spatius converts avatar speech audio into real-time motion data. Motion Server receives audio and returns motion data. AvatarKit renders the Avatar locally on the client. Spatius does not return finished video. Conversation logic is outside Spatius unless a platform integration provides it. ASR, LLM, TTS, turn-taking, and interruption policy are owned by your app, your agent framework, or your backend.

Start by scenario

If you are building…Start hereThen read
A client-side avatar from existing speech audioDirect Mode IntegrationThe platform page under /direct-mode/, then the matching Client SDK reference.
A LiveKit Agents voice avatarLiveKit Agents IntegrationLiveKit Agents quickstart, Server, Client.
An Agora Convo AI avatarAgora Convo AI IntegrationConvo AI Agent, TEN Extension, Client.
A backend-owned ASR / LLM / TTS pipelineBackend Mode IntegrationServer SDK role, Client SDK role, then a transport page.
A first runnable demoQuickstartsDemo Matrix.
Exact method names, enums, and request fieldsReference OverviewThe matching SDK, Session Token API, Regions, or Error Codes page.

Integration path map

PathCategoryWhat connects to SpatiusWhat the client doesBest first page
Direct Mode IntegrationStandalone IntegrationAvatarKit client SDK connects directly to Motion Server.Renders locally, sends audio, receives motion data.Direct Mode Integration
LiveKit Agents IntegrationPlatform Integrationlivekit-plugins-spatius in a LiveKit Agents worker.Web client renders avatar output from the LiveKit room.LiveKit Agents Integration
Agora Convo AI IntegrationPlatform IntegrationAgora Convo AI avatar provider or TEN extension.Web, iOS, or Android client renders avatar output from Agora.Agora Convo AI Integration
Backend Mode IntegrationStandalone IntegrationDeveloper backend connects to Motion Server through a Server SDK.Client receives encoded audio payloads and motion data payloads from the backend.Backend Mode Integration

Key distinction

LiveKit appears in two different places:
ShapeWhat it meansPage
LiveKit Agents IntegrationLiveKit Agents is the agent framework, and livekit-plugins-spatius connects the agent worker to Spatius.LiveKit Agents Integration
Backend Mode with LiveKitYour backend owns the Server SDK pipeline, and LiveKit is only the downstream transport to clients.Backend Mode with LiveKit
Do not treat these as the same integration path.

Reference lookup map

NeedRead
Which SDK supports which capabilitySDK Capability Matrix
Web SDK classes, methods, enumsAvatarKit Web SDK Reference
Web build tooling and WASM setupToolchain Setup
LiveKit or Agora RTC rendering on WebRTC Adapter
React avatar componentsAvatarKit UI
iOS APIsiOS SDK Reference
Android APIsAndroid SDK Reference
Flutter APIsFlutter SDK Reference
Python Server SDKPython SDK
Go Server SDKGolang SDK
Session Token endpointSession Token API
Direct Mode token flowSession Token Auth Flow
Supported regions and endpoint compositionRegions
Client-side recovery guidanceClient Error Codes
Server-side recovery guidanceServer Error Codes

Concepts vs Reference

Page typeUse it forDo not use it for
GuidesChoosing a path, running a quickstart, and wiring an integration.Exhaustive API signatures.
ConceptsMental model, lifecycle, state, audio rules, avatar behavior, and cross-cutting warnings.Method-by-method SDK lookup.
ReferenceExact classes, methods, enums, request fields, endpoint regions, and error codes.Product onboarding narrative.
FAQCommon product and integration questions from developer Q&A.Source of truth for SDK signatures.

Canonical terms

TermMeaning
SpatiusThe product.
Motion ServerCloud service that receives audio and returns motion data.
motion dataThe real-time driving data stream consumed by AvatarKit.
AvatarKitClient-side SDK for avatar loading, rendering, playback, and control.
Direct Mode IntegrationClient connects directly to Motion Server.
Backend Mode IntegrationBackend connects to Motion Server and transports payloads to clients.
LiveKit Agents IntegrationPlatform Integration using LiveKit Agents and livekit-plugins-spatius.
Agora Convo AI IntegrationPlatform Integration using Agora Convo AI or TEN Framework.
@spatius/avatarkit-rtcWeb SDK RTC transport adapter for LiveKit and Agora providers.

AI reading order

When an AI agent answers a Spatius integration question, read pages in this order:
  1. This docs map.
  2. Choose Your Integration Path.
  3. The selected path overview page.
  4. Credentials and Regions if auth or deployment is involved.
  5. The exact SDK or Session Token API reference page.
  6. Error code pages or FAQ only when debugging.

Next steps

Choose your integration path

Compare Direct Mode, LiveKit Agents, Agora Convo AI, and Backend Mode.

Open Reference Overview

Find exact SDK APIs, Session Token API pages, regions, and error codes.