iOS Quickstart

iOS scenario demo

Run four complete AvatarKit scenes on an iOS device. Current demo integration: Agora Convo AI.

Prerequisites

macOS with Xcode and XcodeGen
A physical iOS device; AvatarKit and Agora do not include simulator slices in this demo
Python 3
Spatius API Key and App ID from Spatius Studio
Agora App ID, App Certificate, and published Agent Pipeline ID

Run it

Clone and start the shared backend

git clone https://github.com/spatius-ai/spatius-scenario-demo.git
cd spatius-scenario-demo/backend
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
cp .env.example .env

Set TRANSPORT=agora and fill the Spatius and Agora credentials in .env. Follow the backend README to align the ASR resource IDs and TTS sample rate with your published Agora agent, then start the backend:

python server.py

The demo backend is unauthenticated. Run it only on your local machine or a trusted LAN; do not expose it publicly.

Keep the printed LAN address—you will enter it on the iOS config screen.

Generate and open the iOS project

In a second terminal:

cd spatius-scenario-demo/ios
xcodegen generate
open SpatiusScenes.xcodeproj

Run a scene

Build to a connected iOS device. On the config screen, enter the backend LAN address, confirm the credentials, and choose a scene.

Start Here

Quickstarts

Integrations

Concepts

Pricing

Examples & Support

iOS scenario demo

Prerequisites

Run it

Next steps

Agora client integration

iOS SDK reference

iOS scenario demo

​Prerequisites

​Run it

​Next steps

Agora client integration

iOS SDK reference

Prerequisites

Run it

Next steps