Quickstart

Installation Guide

This guide will help you get started with the Youzu.ai platform.

Prerequisites

Before you begin, ensure you have:

  • A Youzu.ai account
  • API credentials from your dashboard:
    • Client Key (x-client-key) - for server-side authentication

Getting API Credentials

  1. Log in to your Youzu.ai dashboard
  2. Navigate to Settings > API Keys
  3. Copy your Client Key
  4. Store the key securely on your server - never expose it in client-side code

Option 1: Using the REST API

You can interact with Youzu.ai directly through the REST API.

Authentication Methods

Youzu uses API keys for admin operations and token generation, then single-use bearer tokens for product reads and feature endpoints. The Authentication Guide is the canonical reference for headers, route scopes, and token generation.

Option 2: Using SDK Components

For quick integration of pre-built UI components in your web application, include our SDK:

Installation via CDN

Add the following script to your HTML:

<script src="https://sdk.youzu.ai/0.0.1-api/youzu-sdk/youzu-sdk.esm.js"></script>

Once included, you can use any Youzu component directly in your HTML:

<youzu-search-lens></youzu-search-lens>
<room-visualizer></room-visualizer>

The SDK components handle authentication and API calls automatically when properly configured.

Next Steps

Previous
Introduction
Next
Authentication