Agentyk Showroom

Integrate Showroom on your website

1. The viewer (recommended)

Add one script and one element where the product image should appear:

<script src="https://showroom.automaat.me/viewer.js" defer></script>

<showroom-viewer account="demo" product="CLUB-ARMCHAIR"
                 features="UPHOLSTERY:LINEN_SAND,LEGS:OAK"
                 options="true"></showroom-viewer>

What visitors get: drag (or swipe) to turn the product through 32 angles, zoom with the buttons, pinch or ctrl+wheel (a 2048 px image is loaded when zoomed), arrow keys, and a 3D & AR button that opens an interactive 3D model; on a desktop it shows a QR code to continue on a phone and place the product in the room at real size.

AttributeMeaning
account, productrequired
featurescomma-separated GROUP:VALUE list; missing groups use their defaults
optionstrue shows swatch pickers for every option group
sizespin image size in px (default 1024)
keypublishable API key, only for products that are not public
arfalse hides the 3D & AR button
apiShowroom host, if viewer.js is served from somewhere else

Connect it to your own option pickers: change the attribute and the viewer updates.

const v = document.querySelector('showroom-viewer');
v.setAttribute('features', 'UPHOLSTERY:VELVET_FOREST,LEGS:WALNUT');
v.addEventListener('showroom-change', (e) => console.log(e.detail.features)); // when a visitor picks a swatch

Styling: the element is a block that takes the width of its container (square stage). Parts can be styled with ::part(stage), ::part(options), ::part(ar-button).

Privacy: the viewer sets no cookies, uses no local storage and contacts no third party; the 3D viewer (model-viewer) and its decoders are served from the Showroom host. It sends anonymous counters (viewer loaded, spun, zoomed, option changed, AR opened) to the Showroom host.

2. Plain image URLs

For product listings, feeds, e-mails or marketplaces, use image URLs directly:

<img src="https://showroom.automaat.me/api/v1/demo/products/TUFTED-SOFA/stills/threequarter/tufted-sofa.webp?feature=UPHOLSTERY:VELVET_FOREST&size=800"
     alt="Tufted Sofa in Velvet Forest" width="800" height="600">

Use srcset with several size values for responsive images. Every combination has stable URLs, so CDNs and browsers cache them. See API.md for all parameters.

3. Private products and API keys

Create a key in Studio -> API keys, restrict it to your domains (e.g. www.example.com), and pass it as the key attribute of the viewer or the key query parameter / X-Api-Key header.

4. Download everything

Studio -> product -> Bulk export builds a zip with every rendered frame, still, GLB and USDZ plus the OpenUSD master and a manifest (combination per file). "Render all combinations" first renders everything that is allowed.

5. Checklist for a good first product

  1. CAD: one file per product (STEP, FBX, OBJ or GLB), parts as separate bodies if possible (seat cushions, back cushions, frame, legs).
  2. Four photos on a plain background, whole product in frame, roughly at seat height: front, back, left (the side on your left when you face the front), right. Keep EXIF data (the focal length is used).
  3. Fabric scans: U3M, or a zip of maps named basecolor / normal / roughness / height (/ sheen / alpha) with the repeat size in mm.
  4. In the Studio: check the part list and their option groups, add values (feature codes) with materials, set defaults, add exclusions, then look at "Fit quality" (overlays and same-camera comparisons).