# SpatialReal

## Docs

- [Welcome to SpatialReal Documentation](https://spatialwalk-6179c111.mintlify.app/overview/introduction.md)
- [Get Your API Keys](https://spatialwalk-6179c111.mintlify.app/overview/get-apikeys.md): To integrate with SpatialReal, first create your API Key.
- [Speech-to-Avatar](https://spatialwalk-6179c111.mintlify.app/overview/speech-to-avatar.md): Run the Speech-to-Avatar demo directly from the official repository
- [Agent](https://spatialwalk-6179c111.mintlify.app/overview/agent.md): Run the full LiveKit + SpatialReal agent demo directly from the official repository
- [How to integrate](https://spatialwalk-6179c111.mintlify.app/overview/integration_overview.md): Choose an integration mode and start from runnable example projects
- [Integration Modes](https://spatialwalk-6179c111.mintlify.app/concepts/integrations.md): Choose the right integration approach for your use case
- [Audio Format and Sample Rate](https://spatialwalk-6179c111.mintlify.app/concepts/audio.md): Audio input format requirements and sample rate configuration across platforms.
- [Client Lifecycle](https://spatialwalk-6179c111.mintlify.app/concepts/lifecycle.md): SDK initialization, avatar loading, connection management, and resource cleanup.
- [Events](https://spatialwalk-6179c111.mintlify.app/concepts/events.md): Available events to handle in your application, and how to handle them.
- [Public Avatar](https://spatialwalk-6179c111.mintlify.app/studio/public-avatar.md): Browse and use pre-built avatars from the SpatialReal library
- [API Keys](https://spatialwalk-6179c111.mintlify.app/studio/aki-key.md): Create and manage API credentials
- [Server Error Codes](https://spatialwalk-6179c111.mintlify.app/resources/server-error.md): Stable server-side SDK error codes and handling fields
- [Client Error Codes](https://spatialwalk-6179c111.mintlify.app/resources/client-error.md): iOS, Android, and Web SDK error codes with recovery guidance
- [FAQ](https://spatialwalk-6179c111.mintlify.app/overview/faq.md): Frequently asked questions
- [Demo Projects](https://spatialwalk-6179c111.mintlify.app/overview/demo-projects.md): Complete working examples for every platform
- [Changelog](https://spatialwalk-6179c111.mintlify.app/overview/changelog.md)
- [Introduction](https://spatialwalk-6179c111.mintlify.app/guide/introduction.md): Step-by-step guides for integrating SpatialReal avatars into your application
- [Speech-to-Avatar Walkthrough](https://spatialwalk-6179c111.mintlify.app/guide/speech-to-avatar-walkthrough.md): Step-by-step code walkthrough for the Speech-to-Avatar quickstart
- [Agent Quickstart Walkthrough](https://spatialwalk-6179c111.mintlify.app/guide/agent-quickstart-walkthrough.md): Step-by-step code walkthrough for the LiveKit Agent + SpatialReal quickstart
- [SDK Mode](https://spatialwalk-6179c111.mintlify.app/guide/sdk-mode.md): Server-driven avatar animation via WebSocket
- [SDK Mode](https://spatialwalk-6179c111.mintlify.app/guide/sdk-mode-web.md): Server-driven avatar animation via WebSocket for Web applications
- [SDK Mode](https://spatialwalk-6179c111.mintlify.app/guide/sdk-mode-ios&android.md): Server-driven avatar animation via WebSocket for iOS and Android applications
- [RTC Mode & Framework Plugin](https://spatialwalk-6179c111.mintlify.app/guide/rtc-mode.md): Use LiveKit as the transport layer for SpatialReal avatars
- [LiveKit Client](https://spatialwalk-6179c111.mintlify.app/guide/rtc-livekit-client.md): Real-time voice communication with avatars using LiveKit
- [Serverside Setup With LiveKit](https://spatialwalk-6179c111.mintlify.app/guide/rtc-livekit-server.md): Server-side setup for LiveKit + SpatialReal avatar
- [Host Mode](https://spatialwalk-6179c111.mintlify.app/guide/host-mode.md): Self-managed networking with AvatarKit Server SDK
- [AvatarKit UI](https://spatialwalk-6179c111.mintlify.app/sdk-reference/web-sdk/avatarkit-ui.md): SpatialReal avatar components for React.
- [API Reference](https://spatialwalk-6179c111.mintlify.app/sdk-reference/web-sdk/api-reference.md): Complete API documentation for AvatarKit Web SDK
- [Changelog](https://spatialwalk-6179c111.mintlify.app/sdk-reference/web-sdk/changelog.md): AvatarKit Web SDK version update history
- [API Reference](https://spatialwalk-6179c111.mintlify.app/sdk-reference/ios-sdk/api-reference.md): Browse the complete API reference
- [Changelog](https://spatialwalk-6179c111.mintlify.app/sdk-reference/ios-sdk/changelog.md): AvatarKit iOS SDK version update history
- [API Reference](https://spatialwalk-6179c111.mintlify.app/sdk-reference/android-sdk/api-reference.md): Browse the complete API reference
- [Changelog](https://spatialwalk-6179c111.mintlify.app/sdk-reference/android-sdk/changelog.md): AvatarKit Android SDK version update history
- [Python SDK](https://spatialwalk-6179c111.mintlify.app/sdk-reference/python-sdk/python-sdk.md): Using the Python Server SDK
- [Golang SDK](https://spatialwalk-6179c111.mintlify.app/sdk-reference/go-sdk/go-sdk.md): Using the Golang SDK
- [JavaScript SDK](https://spatialwalk-6179c111.mintlify.app/sdk-reference/js-sdk/js-sdk.md): Server SDK for JavaScript/Node.js
- [Server API Reference](https://spatialwalk-6179c111.mintlify.app/api-reference/api-reference.md): Server-side API Reference
- [Authentication](https://spatialwalk-6179c111.mintlify.app/api-reference/auth.md): Authentication Flow
- [Regions](https://spatialwalk-6179c111.mintlify.app/api-reference/regions.md): Available regions, how to configure and how to fallback to other region for higher availability.

## OpenAPI Specs

- [openapi](https://spatialwalk-6179c111.mintlify.app/api-reference/openapi.json)


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