Skip to main content

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.

Use this guide when your iOS app already has avatar speech audio and needs AvatarKit to send that audio to Motion Server, receive motion data, and render the avatar locally.

iOS Direct Mode demo

Swift / SwiftUI reference implementation for the Direct Mode path.

​
SDK package setup

1

Download the framework

Download the latest AvatarKit.xcframework from the releases page.
2

Add it to your Xcode project

Unzip the archive and drag AvatarKit.xcframework into your Xcode project.In your target’s General tab, make sure it appears under Frameworks, Libraries, and Embedded Content with Embed & Sign.

​
Integration flow

1

Create credentials

Create an App ID and Avatar ID in Spatius Studio, then mint a Session Token from your backend. See Credentials.
2

Initialize AvatarKit

Initialize the iOS SDK with your App ID, Avatar ID, Session Token, and us-west region.
3

Send avatar speech audio

Send PCM16 mono avatar speech audio to AvatarKit. Motion Server returns motion data, and AvatarKit renders the avatar locally.

​
Next steps

iOS SDK reference

Complete iOS API documentation.

Browse all demos

Every runnable demo by platform and integration path.