> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spatius.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Demo Projects

> Runnable end-to-end examples mapped by platform and integration path.

The Spatius demo repository is the runnable companion to these docs. Use it when you want to clone code, fill credentials, and see an avatar render, connect, and speak.

<Card title="spatius-ai/spatius-avatar-demo" icon="github" href="https://github.com/spatius-ai/spatius-avatar-demo" horizontal>
  One consolidated repository containing every demo referenced from these docs.
</Card>

<Note>
  The Reference tab documents the packages and APIs you import into your app. Demo projects are end-to-end examples that combine SDKs, credentials, client apps, and optional backend services.
</Note>

## Demo matrix

Use this page after you know which integration path you are evaluating. For the decision itself, start with [Choose Your Integration Path](/getting-started/how-to-integrate#compare-integration-effort).

| Platform    | Direct Mode                                                                                                                                                                                                                                                                                                                               | Backend Mode                                                                                                            | LiveKit Agents Integration                                                                                                                                                                                                                                                                                                                                                                                        | Agora Convo AI Integration                                                                                                                                                                                                                                                                                             |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Web**     | [Web quickstart](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/direct-mode/clients/web/quickstart) — bundled sample audio plus optional realtime conversation<br />[Web reference clients](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/direct-mode/clients/web/reference) — React / Vue / vanilla / Next.js | [Web Backend Mode client](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/backend-mode/clients/web)         | [LiveKit Agents Integration quickstart](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/platform-integrations/livekit-agents-demo/livekit-agent-quickstart) — Gemini Live quickstart<br />[LiveKit Agents Integration reference](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/platform-integrations/livekit-agents-demo/livekit-agents-reference-demo) — cascade & end-to-end backends | [Convo AI Agent guide](/agora-convoai/convo-ai-agent), [TEN extension source](https://github.com/TEN-framework/ten-framework/tree/main/ai_agents/agents/ten_packages/extension/spatius_avatar_python), and [Agora client guide](/agora-convoai/client). Packaged Web demo not provided in `spatius-avatar-demo` today. |
| **iOS**     | [iOS Direct Mode](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/direct-mode/clients/ios)                                                                                                                                                                                                                                    | [iOS Backend Mode client](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/backend-mode/clients/ios)         | Not provided today. LiveKit iOS SDKs exist, but the current AvatarKit RTC demo path is Web-only.                                                                                                                                                                                                                                                                                                                  | [`AvatarKitRTC` iOS SDK](https://github.com/spatius-ai/avatarkit-ios-rtc) plus [Agora client guide](/agora-convoai/client). Packaged iOS demo not provided in `spatius-avatar-demo` today.                                                                                                                             |
| **Android** | [Android Direct Mode](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/direct-mode/clients/android)                                                                                                                                                                                                                            | [Android Backend Mode client](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/backend-mode/clients/android) | Not provided today. LiveKit Android SDKs exist, but the current AvatarKit RTC demo path is Web-only.                                                                                                                                                                                                                                                                                                              | Android RTC SDK support via `ai.spatius:avatarkit-rtc` plus [Agora client guide](/agora-convoai/client). Packaged Android demo not provided in `spatius-avatar-demo` today.                                                                                                                                            |
| **Flutter** | [Flutter Direct Mode](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/direct-mode/clients/flutter)                                                                                                                                                                                                                            | [Flutter Backend Mode client](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/backend-mode/clients/flutter) | Not provided today. The current AvatarKit RTC demo path is Web-only.                                                                                                                                                                                                                                                                                                                                              | Not provided today. Agora Convo AI client support currently covers Web, iOS, and Android.                                                                                                                                                                                                                              |

Classification reminder:

* **LiveKit Agents Integration** belongs to [Platform Integrations](/livekit-agents/overview).
* **Agora Convo AI Integration** belongs to [Platform Integrations](/agora-convoai/overview).
* **Direct Mode** and **Backend Mode** belong to [Standalone Integrations](/getting-started/how-to-integrate).
* The **LiveKit Room example** validates the [RTC Adapter](/sdk-reference/web-sdk/rtc-adapter) wiring against a LiveKit room (token, connect, adapter init, avatar load, mic publish). Remote audio playback and motion-driven rendering only happen when a producer is publishing into the room — it is not the full Backend Mode + RTC transport voice-agent demo.

Transport options such as Backend Mode with LiveKit, Backend Mode with Agora egress, and your own WebSocket are configured inside the relevant integration guide. They are not top-level demo categories.

## Recommended starting points

The entries below are ordered by what they prove, not by product preference. Use quickstarts for first validation, reference demos for production shape, and Backend Mode demos only when your backend owns the runtime pipeline.

| Goal                                            | Start here                                                                                                                                                                                                                                                                                                                                | What it proves                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Web Direct Mode quickstart                      | [`quickstart`](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/direct-mode/clients/web/quickstart)                                                                                                                                                                                                                            | App ID, Avatar ID, Session Token, bundled sample audio, optional browser realtime conversation, Motion Server connection, and avatar rendering.                                                                                                                                                                                                                                                                                                          |
| Full Web client reference                       | [Web Direct Mode reference](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/direct-mode/clients/web/reference)                                                                                                                                                                                                                | Direct Mode SDK integration across React, Vue, vanilla JavaScript, and Next.js.                                                                                                                                                                                                                                                                                                                                                                          |
| iOS / Android / Flutter Direct Mode samples     | [iOS Direct Mode](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/direct-mode/clients/ios), [Android Direct Mode](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/direct-mode/clients/android), or [Flutter Direct Mode](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/direct-mode/clients/flutter) | Native and Flutter AvatarKit setup with runtime Session Token input.                                                                                                                                                                                                                                                                                                                                                                                     |
| Fastest Web voice-agent demo                    | [LiveKit Agents Integration quickstart](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/platform-integrations/livekit-agents-demo/livekit-agent-quickstart)                                                                                                                                                                   | LiveKit token server, agent dispatch, `livekit-plugins-spatius`, AvatarKit RTC, and microphone flow.                                                                                                                                                                                                                                                                                                                                                     |
| Full LiveKit Agents Integration reference       | [LiveKit Agents Integration reference](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/platform-integrations/livekit-agents-demo/livekit-agents-reference-demo)                                                                                                                                                               | Cascade and end-to-end agent backends with Vite and Next.js frontend apps.                                                                                                                                                                                                                                                                                                                                                                               |
| Agora Convo AI Integration                      | [Convo AI Agent guide](/agora-convoai/convo-ai-agent)                                                                                                                                                                                                                                                                                     | Configure Spatius as the Convo AI avatar provider, then pair it with the [Agora client guide](/agora-convoai/client). Use [`spatius_avatar_python`](https://github.com/TEN-framework/ten-framework/tree/main/ai_agents/agents/ten_packages/extension/spatius_avatar_python) only for direct TEN Framework graphs.                                                                                                                                        |
| Backend-owned audio pipeline                    | [Backend Mode reference](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/backend-mode)                                                                                                                                                                                                                                        | Backend-owned ASR, LLM, TTS pipeline and thin clients that consume encoded audio payloads and motion data payloads.                                                                                                                                                                                                                                                                                                                                      |
| RTC Adapter LiveKit example                     | [`platform-integrations/livekit-room-demo`](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/platform-integrations/livekit-room-demo)                                                                                                                                                                                          | Validates `@spatius/avatarkit-rtc` + `LiveKitProvider` wiring (token, connect, adapter init, avatar load, mic publish). Remote audio playback and motion rendering only when a producer is in the room. Not the full voice-agent pattern.                                                                                                                                                                                                                |
| Backend Mode + RTC transport (full voice agent) | Not packaged in this repository yet                                                                                                                                                                                                                                                                                                       | Full pattern: backend owns ASR / LLM / TTS / Server SDK, mints LiveKit tokens, and publishes audio + motion into the LiveKit room; RTC Adapter renders in the Web client. Assemble from the Backend Mode demo + the LiveKit example above, or use the [LiveKit Agents quickstart](https://github.com/spatius-ai/spatius-avatar-demo/tree/main/platform-integrations/livekit-agents-demo/livekit-agent-quickstart) for an end-to-end runnable equivalent. |

## Clone and run

```bash theme={null}
git clone https://github.com/spatius-ai/spatius-avatar-demo.git
cd spatius-avatar-demo
```

Each demo folder has its own README with `.env.example`, dependency installation, and run commands. The READMEs are the source of truth for run instructions; this page is the index.

## Next steps

<CardGroup cols={2}>
  <Card title="Choose your integration path" icon="route" href="/getting-started/how-to-integrate">
    Compare latency, production ownership, and developer effort.
  </Card>

  <Card title="Quickstarts" icon="bolt" href="/quickstarts/overview">
    Run the platform SDK quickstarts before diving into a full demo.
  </Card>
</CardGroup>
