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 Secret (x-client-secret) - for server-side authentication

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

You can interact with Youzu.ai directly via our REST API. All API requests require authentication using your Client Key.

API Key Authentication (for most endpoints)

x-client-secret: YOUR_CLIENT_SECRET

Token Authentication (for protected endpoints)

Authorization: Bearer YOUR_TOKEN

See the Authentication Guide for details on generating tokens.

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

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.