iOS SDK Quickstart

GitHub Repository

SwiftUI sample implementing the avatar pipeline: VAD → ASR → LLM → TTS → AvatarKit.

This quickstart targets the Direct Mode path on iOS. The sample app pastes the Session Token in the UI rather than fetching from a backend — convenient for first-run validation.

Prerequisites

Xcode 16+
iOS 16+ device or simulator (real device recommended for mic input)
Spatius credentials. See Credentials.
- App ID — from Spatius Studio
- Avatar ID — from the Avatar Library
- Session Token — see Session token API
An OpenAI API key for the ASR + LLM + TTS pipeline used by the sample.

Run it

Clone and open the sample

git clone https://github.com/spatius-ai/spatius-avatar-demo.git
cd spatius-avatar-demo/direct-mode/clients/ios
brew install xcodegen

Generate and open the Xcode project:

xcodegen generate
open AvatarDemo.xcodeproj

Configure credentials

Edit AvatarDemo/Config.swift:

appID = "<your-app-id>"
avatarID = "<your-avatar-id>"
openAIApiKey = "<your-openai-api-key>"

Session Token is not stored in Config.swift — paste it in the app UI at runtime.

Build and run

Use Xcode to build and run on a connected iOS device or simulator. The AvatarKit.xcframework is downloaded automatically on first build from the configured release.

Start a conversation

In the running app:

Paste your Session Token.
Tap Start Conversation.
Speak and pause. The avatar should respond with lip-synced speech.

What this validates

Check	What it tells you
Avatar renders	App ID + Avatar ID are correct, framework is correctly embedded.
Conversation starts	Session Token is valid, Motion Server connection works.
Avatar speaks	Full pipeline (mic → ASR → LLM → TTS → AvatarKit) is wired up end to end.

Start Here

Quickstarts

Platform Integrations

Standalone Integrations

Concepts

Examples & Support

iOS SDK Quickstart

GitHub Repository

Prerequisites

Run it

What this validates

Next steps

iOS SDK reference

Browse all demos

GitHub Repository

​Prerequisites

​Run it

​What this validates

​Next steps

iOS SDK reference

Browse all demos

Prerequisites

Run it

What this validates

Next steps