SDK & DOCS

LumeCore SDK. One shade catalog. Every channel.

JS embed for web storefronts, npm package for React and headless, native SDKs for iOS Swift and Android Kotlin. Upload your catalog once — the same shade accuracy everywhere your brand sells.

Request API Key 5-Min Quickstart
GETTING STARTED

Three steps to live try-on.

1
Get your API key

Start a free trial to receive your lmg_live_* API key. Sandbox key included for dev/staging.

2
Upload your shade catalog

POST your product SKUs with HEX values and finish types to the Catalogs API, or use the dashboard CSV importer.

3
Embed on your PDP

Add the script tag and mount div. The try-on layer renders in your existing product page — no iframe, no popup.

npm install bash
# npm (React / Next.js) npm install @lumeglint/sdk # or CDN script tag <script src="https://cdn.lumeglint.com/sdk/v1/lumecore.min.js" data-key="lmg_live_YOUR_KEY"></script>
JS EMBED

Web integration.

For Shopify, WooCommerce, or any JS storefront, the full embed is about five minutes. The LumeCore loader auto-detects the product ID from your data-product-id attribute and pulls your shade catalog from the API. No backend work required.

  • No video stream leaves the device — camera data stays in browser memory
  • Sub-100ms shade switching — no network round-trip per shade
  • WebAssembly-based — works in all modern browsers including Safari iOS
React component JSX
import { LumeTryOn } from '@lumeglint/sdk'; export default function ProductPage({ product }) { return ( <LumeTryOn apiKey="lmg_live_YOUR_KEY" productId={product.id} catalogId="cat_lipstick_2025" onShadeSelect={(shade) => console.log(shade)} /> ); }
REST API

Core endpoints.

Full OpenAPI spec and request/response examples in the API Reference docs.

Endpoint Method Description
/v1/sessions POST Create a new try-on session token for a product page
/v1/sessions/{id} GET Retrieve session metadata and shade interaction history
/v1/shades GET List all shades in a catalog, with render metadata
/v1/shades POST Create or batch-import shades to a catalog
/v1/analytics/sessions GET Aggregate session stats: daily sessions, shade pick rate, cart events
WEBHOOKS

Real-time events.

LumeCore fires HMAC-signed webhook events to your endpoint for key shopper actions. Use them to trigger cart analytics, segment audiences by shade preference, or feed shade dwell-time data into your product strategy.

  • session.started Shopper activates camera
  • shade.selected Shopper picks a shade to render
  • cart.intent Shopper taps Add to Cart during session
  • session.ended Session closes (navigated away or timeout)
webhook payload JSON
{ "event": "shade.selected", "session_id": "ses_1a2b3c4d", "product_id": "prod_matte_rose_06", "shade": { "id": "shd_rose_crimson", "hex": "#B8245C", "finish": "matte" }, "latency_ms": 62, "timestamp": "2025-09-01T14:22:09Z" }

Get your API key today.

Request a key and you'll have a sandbox environment within minutes. Start with the quickstart guide — most Shopify brands are rendering live shades the same day.

Request API Key Full Documentation