Web Quickstart

Web scenario demo

Run four complete avatar scenes in the browser.

The Web demo supports both recommended integrations. Choose livekit to run the conversation through LiveKit Agents on your machine, or agora to use Agora Convo AI.

Prerequisites

Python 3 and Node.js with pnpm
Spatius API Key and App ID from Spatius Studio
One realtime provider:
- LiveKit URL, API Key, and API Secret from LiveKit Cloud
- Or Agora App ID, App Certificate, and published Agent Pipeline ID

Run it

Clone the scenario demo

git clone https://github.com/spatius-ai/spatius-scenario-demo.git
cd spatius-scenario-demo

Configure the shared backend

cd backend
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
cp .env.example .env

In .env, set TRANSPORT=livekit or TRANSPORT=agora, then fill the Spatius and matching provider credentials. The backend README lists every field. For Agora, also follow its required ASR resource-ID and TTS sample-rate setup.

Start the backend

python server.py

Keep it running. It listens on port 8787 and starts the LiveKit agent worker automatically when TRANSPORT=livekit.

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

Start the Web client

In a second terminal:

cd spatius-scenario-demo/web
pnpm install
pnpm dev

Open http://localhost:5180/spatius-scenario-demo/, confirm the backend configuration, then choose a scene.

Start Here

Quickstarts

Integrations

Concepts

Examples & Support

Web scenario demo

Prerequisites

Run it

Next steps

LiveKit Agents

Agora Convo AI

Web scenario demo

​Prerequisites

​Run it

​Next steps

LiveKit Agents

Agora Convo AI

Prerequisites

Run it

Next steps