Overview

This guide explains how to send your product data to Youzu.ai, which is essential for powering visual search, product recommendations, and other AI features.

Youzu.ai offers multiple methods for product data ingestion to accommodate different business needs and technical capabilities.

Available Ingestion Methods

1. Real-time Import API - Send product updates and new products in real-time using JSON
2. API Batch Import - Upload large product catalogs via file URLs (CSV, JSON, XML)
3. Manual Dashboard Upload - User-friendly interface for uploading product data through the Youzu.ai dashboard

Choosing the Right Method

Creating a Catalogue

Before you can ingest products, you need to create a catalogue. A catalogue organizes your products and allows you to manage them effectively.

Endpoint

POST https://platform.youzu.ai/api/v1/admin/catalogue
Content-Type: application/json
x-client-secret: YOUR_CLIENT_SECRET

const createCatalogue = async () => {
  const response = await fetch('https://platform.youzu.ai/api/v1/admin/catalogue', {
    method: 'POST',
    headers: {
      'x-client-secret': 'YOUR_CLIENT_SECRET',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: 'My Product Catalogue'
    })
  });

  if (response.ok) {
    const catalogue = await response.json();
    console.log('Catalogue created:', catalogue.id);
    return catalogue.id;
  } else {
    console.error('Failed to create catalogue');
  }
};

import requests

def create_catalogue():
    url = 'https://platform.youzu.ai/api/v1/admin/catalogue'
    headers = {
        'x-client-secret': 'YOUR_CLIENT_SECRET',
        'Content-Type': 'application/json'
    }
    data = {
        'name': 'My Product Catalogue'
    }
    
    response = requests.post(url, headers=headers, json=data)
    
    if response.status_code == 201:
        catalogue = response.json()
        print(f"Catalogue created: {catalogue['id']}")
        return catalogue['id']
    else:
        print(f"Failed to create catalogue: {response.status_code}")

curl -X POST https://platform.youzu.ai/api/v1/admin/catalogue \
  -H "x-client-secret: YOUR_CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Product Catalogue"
  }'

Managing Catalogues

Once created, you can manage your catalogues using these endpoints:

List All Catalogues

GET https://platform.youzu.ai/api/v1/admin/catalogue
x-client-secret: YOUR_CLIENT_SECRET

Get a Specific Catalogue

GET https://platform.youzu.ai/api/v1/admin/catalogue/{catalogueId}
x-client-secret: YOUR_CLIENT_SECRET

Delete a Catalogue

DELETE https://platform.youzu.ai/api/v1/admin/catalogue/{catalogueId}
x-client-secret: YOUR_CLIENT_SECRET

Getting Started

1. Review the product data requirements to ensure your product information is optimized for Youzu.ai
2. Select the ingestion method that best fits your business needs
3. Prepare your data according to the requirements
4. Follow the implementation steps for your chosen method