Developer Docs Map

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 here	Then read
A client-side avatar from existing speech audio	Direct Mode Integration	The platform page under `/direct-mode/`, then the matching Client SDK reference.
A LiveKit Agents voice avatar	LiveKit Agents Integration	LiveKit Agents quickstart, Server, Client.
An Agora Convo AI avatar	Agora Convo AI Integration	Convo AI Agent, TEN Extension, Client.
A backend-owned ASR / LLM / TTS pipeline	Backend Mode Integration	Server SDK role, Client SDK role, then a transport page.
A first runnable demo	Quickstarts	Demo Matrix.
Programmatic Avatar creation from a backend	Spatius API Overview	Authentication, Errors and Limits, then the endpoint pages.
Exact method names, enums, and request fields	Reference Overview	The matching SDK, Session Token API, Regions, or Error Codes page.

Integration path map

Path	Category	What connects to Spatius	What the client does	Best first page
Direct Mode Integration	Standalone Integration	AvatarKit client SDK connects directly to Motion Server.	Renders locally, sends audio, receives motion data.	Direct Mode Integration
LiveKit Agents Integration	Platform Integration	`livekit-plugins-spatius` in a LiveKit Agents worker.	Web client renders avatar output from the LiveKit room.	LiveKit Agents Integration
Agora Convo AI Integration	Platform Integration	Agora Convo AI avatar provider or TEN extension.	Web, iOS, or Android client renders avatar output from Agora.	Agora Convo AI Integration
Backend Mode Integration	Standalone Integration	Developer 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:

Shape	What it means	Page
LiveKit Agents Integration	LiveKit Agents is the agent framework, and `livekit-plugins-spatius` connects the agent worker to Spatius.	LiveKit Agents Integration
Backend Mode with LiveKit	Your 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

Need	Read
Which SDK supports which capability	SDK Capability Matrix
Web SDK classes, methods, enums	AvatarKit Web SDK Reference
Web build tooling and WASM setup	Toolchain Setup
LiveKit or Agora RTC rendering on Web	RTC Adapter
React avatar components	AvatarKit UI
iOS APIs	iOS SDK Reference
Android APIs	Android SDK Reference
Flutter APIs	Flutter SDK Reference
Python Server SDK	Python SDK
Go Server SDK	Golang SDK
Session Token endpoint	Session Token API
Programmatic Avatar creation	Spatius API Overview
Direct Mode token flow	Session Token Auth Flow
Supported regions and endpoint composition	Regions
Client-side recovery guidance	Client Error Codes
Server-side recovery guidance	Server Error Codes

Concepts vs Reference

Page type	Use it for	Do not use it for
Guides	Choosing a path, running a quickstart, and wiring an integration.	Exhaustive API signatures.
Concepts	Mental model, lifecycle, state, audio rules, avatar behavior, and cross-cutting warnings.	Method-by-method SDK lookup.
SDK Reference	Exact classes, methods, enums, request fields, endpoint regions, and error codes.	Product onboarding narrative.
API Reference	Spatius API endpoints for programmatic avatar creation, authentication rules, and job polling.	Client SDK signatures or integration quickstarts.
FAQ	Common product and integration questions from developer Q&A.	Source of truth for SDK signatures.

Canonical terms

Term	Meaning
Spatius	The product.
Motion Server	Cloud service that receives audio and returns motion data.
motion data	The real-time driving data stream consumed by AvatarKit.
AvatarKit	Client-side SDK for avatar loading, rendering, playback, and control.
Direct Mode Integration	Client connects directly to Motion Server.
Backend Mode Integration	Backend connects to Motion Server and transports payloads to clients.
LiveKit Agents Integration	Platform Integration using LiveKit Agents and `livekit-plugins-spatius`.
Agora Convo AI Integration	Platform Integration using Agora Convo AI or TEN Framework.
`@spatius/avatarkit-rtc`	Web 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:

This docs map.
Choose Your Integration Path.
The selected path overview page.
Credentials and Regions if auth or deployment is involved.
The exact SDK or Session Token API reference page.
Error code pages or FAQ only when debugging.

Start Here

Quickstarts

Platform Integrations

Standalone Integrations

Concepts

Examples & Support

Developer Docs Map

What Spatius does

Start by scenario

Integration path map

Key distinction

Reference lookup map

Concepts vs Reference

Canonical terms

AI reading order

Next steps

Choose your integration path

Open Reference Overview

​What Spatius does

​Start by scenario

​Integration path map

​Key distinction

​Reference lookup map

​Concepts vs Reference

​Canonical terms

​AI reading order

​Next steps

Choose your integration path

Open Reference Overview

What Spatius does

Start by scenario

Integration path map

Key distinction

Reference lookup map

Concepts vs Reference

Canonical terms

AI reading order

Next steps