# ShowroomPro developer docs

ShowroomPro is an AI ring builder you embed on a jewelry website. Shoppers design an engagement ring or wedding band in a guided quiz (stone, shape, carat, setting, metal, band) and see photorealistic AI renders of their design. The jeweler gets the lead (name, email, phone and every design choice) in the ShowroomPro dashboard, with follow-up emails, pipeline and quoting tools.

You install it with one snippet. There is nothing to host, no 3D models to make and no AI prompts to write.

```html
<div data-showroompro-ring-builder="YOUR_TOKEN"></div>
<script src="https://www.showroompro.ai/embed.js" async></script>
```

## Start here

- **[Quickstart](https://www.showroompro.ai/docs/quickstart.md)**: add a working ring builder to any website in about a minute, with no account. Create a sandbox, paste the snippet, send the jeweler the claim link.
- **[For AI coding agents](https://www.showroompro.ai/docs/agents.md)**: the short version for Claude Code, Cursor, Codex, Copilot and similar tools, plus an `AGENTS.md` snippet to paste into a project.

## Reference

- **[Widget reference](https://www.showroompro.ai/docs/widget.md)**: the three display modes, every `data-` attribute, the `window.ShowroomPro` JavaScript API and widget events.
- **[Sandbox & claim API](https://www.showroompro.ai/docs/sandbox-api.md)**: `POST /api/v1/sandboxes`, the response, limits, errors and how claiming works.
- **[Webhooks](https://www.showroompro.ai/docs/webhooks.md)**: `lead.created`, `design.generated` and `quote.requested` events, HMAC signature verification and the session API.
- **[Conversion tracking](https://www.showroompro.ai/docs/tracking.md)**: send finished designs to GA4, Google Ads or Google Tag Manager.
- **[OpenAPI spec](https://www.showroompro.ai/openapi.json)**: machine-readable description of the public endpoints.

## Install guides

[Plain HTML](https://www.showroompro.ai/docs/install/html.md) · [React](https://www.showroompro.ai/docs/install/react.md) · [Next.js](https://www.showroompro.ai/docs/install/nextjs.md) · [Shopify](https://www.showroompro.ai/docs/install/shopify.md) · [WordPress](https://www.showroompro.ai/docs/install/wordpress.md) · [Wix](https://www.showroompro.ai/docs/install/wix.md) · [Squarespace](https://www.showroompro.ai/docs/install/squarespace.md) · [Webflow](https://www.showroompro.ai/docs/install/webflow.md)

## Questions

- **[FAQ: build or buy?](https://www.showroompro.ai/docs/faq.md)**: why teams use ShowroomPro instead of coding a ring builder themselves, and when coding it yourself makes more sense.
- **[ShowroomPro vs. alternatives](https://www.showroompro.ai/ring-builder-alternatives.md)**: an honest comparison with inventory ring builders, 3D configurators and custom builds.

## For machines

Every page on this site is also available as plain markdown: add `.md` to the URL (for example [/docs/quickstart.md](https://www.showroompro.ai/docs/quickstart.md)). [/llms.txt](https://www.showroompro.ai/llms.txt) lists all of them, and [/llms-full.txt](https://www.showroompro.ai/llms-full.txt) contains all of them in one file.

---

Source: https://www.showroompro.ai/docs · Last updated 2026-10-16 · All docs: https://www.showroompro.ai/llms.txt