> ## Documentation Index
> Fetch the complete documentation index at: https://spatialwalk-6179c111.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# How to integrate

> Choose an integration mode and start from runnable example projects

> [!NOTE]
>
> SpatialReal currently provides **avatar-only** services, focusing on generating and rendering real-time avatar animations based on audio input. Voice conversation logic, speech synthesis, and other agent functionalities are managed by your application or third-party services.

## Compare Integration Modes

| Mode | Characteristic | Latency | Dev Effort | Ideal Scenario |
| - | - | - | - | - |
| **[SDK Mode](https://spatialwalk-6179c111.mintlify.site/concepts/integrations.md#sdk-mode)** | Client-centric | Moderate ⏱️ | Low 🟢 | Easy client-centric integration. |
| **[Framework Plugin](https://spatialwalk-6179c111.mintlify.site/concepts/integrations.md#framework-plugin)** | Voice agent framework plugin | Ultra-Low ⚡ | Low 🟢 | Use [LiveKit Agents](https://docs.livekit.io/agents/) or [TEN Framework](https://theten.ai/). |
| **[RTC Mode](https://spatialwalk-6179c111.mintlify.site/concepts/integrations.md#rtc-mode)** | Transport via Agora/LiveKit | Ultra-Low ⚡ | Medium 🟡 | You want to optimize latency, and use LiveKit or Agora as transport layer |
| **[Host Mode](https://spatialwalk-6179c111.mintlify.site/concepts/integrations.md#host-mode)** | Use your own transport layer | Low 💨 | High 🔴 | Full control over data transport. |

## Start from Runnable Examples

> **[AvatarKit Voice Agent Demo](https://github.com/spatialwalk/avatarkit-voice-agent-demo/tree/main/livekit-agents)**
>
> A collection of example projects that can work out of the box after API keys are filled in `.env`.

```bash theme={null}
git clone https://github.com/spatialwalk/avatarkit-voice-agent-demo.git
cd avatarkit-voice-agent-demo
```

## Guides

> **[SDK Mode Guide](https://spatialwalk-6179c111.mintlify.site/guide/sdk-mode.md)**
>
> Start with client-centric integration.

> **[Host Mode Guide](https://spatialwalk-6179c111.mintlify.site/guide/host-mode.md)**
>
> Build custom transport and server orchestration.

> **[RTC Mode & Framework Plugin Guide](https://spatialwalk-6179c111.mintlify.site/guide/rtc-mode.md)**
>
> Use LiveKit or Agora for real-time delivery, including LiveKit Agents and TEN Framework integration.

## Want to Learn More?

Read the full [Integration Modes](https://spatialwalk-6179c111.mintlify.site/concepts/integrations.md) doc to understand the technical details, service architecture, and best practices for each integration mode.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.