Installation Guide

This guide will help you install and set up the Youzu.ai components in your application.

Prerequisites

Before you begin, ensure you have the following:

• A Youzu.ai account
• An API key from your dashboard
• A modern web browser
• Node.js (if using JavaScript/TypeScript)

Using Pre-built Components

Installation via CDN

To quickly add Youzu components to your site, include the following in your HTML:

<script src="https://cdn.youzu.ai/sdk/latest/youzu.min.js"></script>

Installation via NPM

For Node.js projects, install the package:

npm install @youzu/ai-components

Then import the components you need:

import { RoomVisualizer, YouzuLens } from '@youzu/ai-components';

Authentication

All components require authentication with a valid API key. Set up your API key as follows:

youzu.init({
  apiKey: 'YOUR_API_KEY_HERE'
});

Component Categories

Our components are organized into three categories:

• Discovery: Components for finding and exploring products
• Room Intelligence: Components for visualizing products in 3D environments
• Interactive: Components for engaging users with real-time interactions

Explore the documentation for each category to learn more about the available components:

• Discovery Components
• Room Intelligence Components
• Interactive Components

Next Steps

After installing the components, follow the quick start guide to implement your first component:

• Quick Start Guide

For detailed component documentation, visit the component category pages listed above.