Skip to main content

Getting Started with SPREEAI

Welcome to SPREEAI Docs.

SPREEAI makes photorealistic try-on simple, fast, and scalable. These docs are your guide to bringing the experience to life — whether you’re a brand preparing assets, a retailer planning a launch, or a developer handling integration.

Inside, you’ll find everything you need to:

  • Understand how SPREEAI works and the different ways to integrate it.
  • Access SDKs and setup guides for iOS, Android, and Web.
  • Upload and manage garments & assets to power your try-ons.
  • Learn what’s required from your team to get started quickly.
  • Follow a clear path from proof of concept/pilot → launch → scale.

How SPREEAI Works​

SPREEAI enables customers to see your garments on real human models instantly. We provide:

  • Photorealistic Try-On – apparel rendered with lifelike fabric, texture, and lighting.
  • Flexible SDKs – iOS, Android, and Web integrations to fit your existing platforms.
  • Hosted Demos – quick setup if you don’t have an app or want to run a pilot.

What you'll need​

  • An API Key from your SPREEAI account dashboard.
  • Choice of integration path: iOS SDK, Android SDK, or Web SDK.
  • A set of garments and assets (images, tech packs, or specs) to begin testing/launch.

Quickstart by Platform​

  • iOS SDK →: Add try-on to your iOS app.
  • Android SDK →: Seamlessly integrate try-ons in Android apps.
  • Web SDK →: Power your website or e-commerce store with try-ons.

From Pilot to Launch​

Every partner journey is unique, but the path is simple:

Explore – Share an initial set of garments with us. We’ll run them through our ingestion service and prepare the first try-on experience.

Test – Review outputs together, provide feedback on visuals, and refine until they meet your brand’s standards.

Launch – Go live by integrating our SDKs into your website or app, or use a hosted experience to get started quickly.

Scale – Continue giving us access to new garments and categories. We’ll work side by side on a glide path to expand features, add sizing and personalization, and unlock larger seasonal or campaign launches.

What We Need From the Brand​

To get started smoothly, here's what we'll ask from your team:

Uploading Garment Assets​

To start, we need some assets from your team to gather information on your desired garments. Upload your assets and we'll start processing in a few days.

  1. Navigate to the Garment Assets page within your partner portal
  2. Select Upload Garment Assets in the top right corner
  3. In the new window, select your files to upload or drag and drop
    1. Bulk upload your files by dragging and dropping
    2. Garment images: see Garment Image Requirements for the accepted formats, resolution, and file size.
    3. Garment metadata: a completed manifest file is required, in CSV or XLS format. Access our additional documents and templates if needed.
    4. Note: Please allow a few days for new uploads to begin internal processing. You may not be able to see your uploaded assets in the table immediately.

After Processing & Going Live​

We'll notify you once your assets are ready to go. Manage these assets by enabling the try-on button to go live or remain inactive.

  1. Once your assets are processed and training is complete, we'll notify you.
  2. For products with the Ready status, you have the option to enable the try-on button, which displays the feature for the selected garment on your PDP.
    1. Select the checkbox on each asset you want the try-on enabled on.
    2. Or manually toggle the checkbox in the enabled column on the far right.
  3. To disable the try-on button, select assets that have the Enabled check and disable the try-on manually or through bulk selection.

Next Step​

  • Review the API Reference for detailed endpoints.
  • Explore Guides to set up your first try-on.
  • Check out Examples to see what’s possible.