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​

These instructions describe the current Partner Portal. An administrator is required to upload or change garment availability.

  1. Open Garments, then choose Add garments.
  2. Download 1 · CSV template and complete its required fields. Review Garment requirements before preparing assets.
  3. Under 2 · Upload completed files, choose files or drag and drop. The picker supports CSV, XLS, XLSX, PNG, JPG, JPEG and WebP.
  4. Choose Upload selected files. Read each file's result and retry failed files only. An accepted upload is not proof that ingestion, processing or QA is complete.
  5. Return to Garments and use Ready, Rendering, Needs assets or QA hold. Search by name or ID; clear both the search and active status filters to restore the full list.

See Garment Image Requirements for the published resolution and file specifications. The picker accepts WebP, while the published image specification currently lists JPEG and PNG. Confirm WebP acceptance, maximum file size and category-specific metadata with support before preparing a batch.

Resource access: The linked CSV template and detailed asset list may require Google access. If a download is denied, ask your SPREEAI contact to grant access to your partner account. Do not submit incomplete metadata or assume a failed download is an empty template.

After Processing and Going Live​

  1. Open a garment's name to inspect its preview images, category, variants and status.
  2. Once processing is complete, an administrator can change the Try-on switch in the garment detail view.
  3. For bulk actions, select garments and use Enable Try-On or Disable Try-On. Review any partial failures.
  4. Verify the result on your storefront. A Ready catalog status alone does not prove that a garment is enabled or visible on a product page.

There is no Enabled column or size-chart mapping workflow in this portal view. If a garment remains in Rendering or QA hold, contact support with its name or ID.

Shopify Setup​

Shopify is optional for the Partner Portal. Warehouse Try-On and catalog reporting remain available without it. Use Get Shopify setup help from Overview or Analytics to open an editable Install support request. Include your authorized store's your-store.myshopify.com domain and review the request before sending. Never include passwords or access tokens.

The team must confirm installation and mapping to the correct partner workspace. The Integrations page contains API keys, SPREEAI integrations and webhooks; it does not contain a self-service Shopify connection button.

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.