Authenticate once, then render try-on or sizing anywhere on the page. Use test credentials issued during onboarding and never put a client secret in browser code.

npm install @spreeai/web-sdk

# or
yarn add @spreeai/web-sdk

import { init } from "@spreeai/web-sdk";

const sdk = await init({
  clientId: "your-client-id",
  partnerId: "your-partner-id",
});

if (sdk) {
  await sdk.renderTryOnButton({
    elementId: "spreeai-try-on",
    garments: [{ garmentId: "your-garment-id" }],
    enableAddToCart: true,
  });
}

events: {
  onTryOnButtonClick: (event) => {
    analytics.track("try_on_started", event);
  },
  onAddToCartClicked: async (event) => {
    // Connect to your existing cart workflow.
  },
}

The integration model

Four systems.
One customer moment.

01Your catalogue

Product IDs, variants, imagery and merchandising context.

02SPREEAI ingestion

Garments move through processing, review and readiness states.

03SDK or API

Your storefront requests the experience for an eligible product.

04Customer action

Try on, find a size, complete the look and return to checkout.

Production path

Take the integration
across the finish line.

A clean launch is more than a working button. Use this sequence to align access, assets, behavior, quality and measurement.

01
Scope the first journey
Choose one channel, catalogue group, customer moment and success measure.
Owner · Product + commerce
02
Prepare access
Confirm the partner ID, approved client credentials, storefront permissions and staging environment.
Owner · Engineering
03
Submit clean assets
Provide one garment per image, front view required, high resolution, clean lighting and SKU-aligned filenames.
Owner · Catalogue team
04
Integrate in staging
Render only on eligible products, connect variants and cart behavior, and match the entry point to the brand.
Owner · Front-end
05
Run launch QA
Test mobile and desktop, browser coverage, accessibility, performance, visual fidelity and failure states.
Owner · QA + brand
06
Enable and measure
Turn on Ready products, publish the staged experience and monitor adoption, completion and conversion.
Owner · Commerce + analytics

Asset baseline

Good input makes a better result.

JPEG or PNG
2,000 × 2,000 px minimum
Front view required
Back view recommended
Neutral, even lighting
SKU or style ID in filename

Open the asset checklist ↗

Developer reference

Find the next
useful answer.

/

Start here

Getting Started

Understand access, supported platforms and the first decisions your team needs to make.

Official reference ↗ Managed integration

Shopify onboarding

Install the app, accept agreements, sync garments, customize the button and go live.

Official reference ↗ Web SDK

API surface

Review initialization, render options, sizing, customization and typed interfaces.

Official reference ↗ Partner API

Public API reference

Explore the approved server-side interface available to authenticated partners.

Swagger reference ↗ Quality

Garment assets

Prepare product imagery and metadata that move cleanly through ingestion and review.

SPREEAI guide ↗ Production

QA & launch

Use the shared browser, performance, accessibility and go-live checklist.

SPREEAI guide ↗ Support

Troubleshooting

Resolve the most common authentication, eligibility, rendering and performance issues.

SPREEAI guide ↗ Documentation

Implementation guides

Browse public quickstarts, asset standards, launch checklists and troubleshooting guidance.

Open documentation ↗

Build for production

The details that protect
the customer experience.

Security

Keep secrets server-side, use only issued environments and rotate credentials through the partner workflow.

Privacy

Request customer imagery with clear consent and align data handling with your approved integration plan.

Performance

Load the experience where it is needed, test real devices and monitor product-page regressions.

Accessibility

Preserve keyboard access, focus order, accessible names and a usable path when the experience is unavailable.

Developer FAQ

Questions before
the first commit.

Which integration should we choose?

Use the Shopify App for the fastest managed path, the Web SDK for custom or headless web placement, the native SDKs for app experiences, and the approved API reference for server-side workflows agreed during onboarding.

Where do credentials come from?

SPREEAI issues the partner ID and approved credentials during onboarding. The browser SDK uses a client ID and partner ID. Never embed a client secret in front-end code.

Does the Shopify App require API keys?

The current Shopify App onboarding flow connects the store after the required agreements and subscription step; the managed app does not require copying keys into the setup screen.

Why does the Try-On button not appear?

Confirm the garment has completed processing, is enabled for Try-On, maps to the active product or variant, and that the app block or SDK container is present on the product template.

Which client events are available?

The documented SDK callbacks cover Try-On button clicks and add-to-cart interactions. Connect them to your analytics layer without including customer imagery or unnecessary personal data.

Are server webhooks available?

Server-push webhooks are not part of the currently published SDK documentation. Scope any server-side event requirement with Partner Engineering before relying on it.

Where do developers get help?

Use the technical support path provided during onboarding or email support@spreeai.com. Include the environment, product ID, browser or device, timestamp and a concise reproduction path—never send secrets.

When will Amazon Partner Network support be available?

The Amazon Partner Network integration is in development. It is intentionally marked Coming Soon until the onboarding and production interface are ready for external developers.

Ready to build?

Choose the path.
We’ll help you ship it.

Book a technical discovery Browse all docs ↗Open Partner Workspace ↗

Build the fitting roominto every screen.

Start where yourcommerce stack lives.

Shopify App

Web SDK

iOS SDK

Android SDK

Public APIs

Amazon Partner Network

From install toworking button.

Four systems.One customer moment.

Take the integrationacross the finish line.

Scope the first journey

Prepare access

Submit clean assets

Integrate in staging

Run launch QA

Enable and measure