Skip to main content

Type Alias: GenerateAR()

GenerateAR = () => Promise<Nullable<string>>

Function

Creates an Augmented Reality (AR) version of the current product configuration.

This action processes the current product with all its customizations and generates an AR-ready model that can be viewed on compatible devices. It returns a unique shortcode that can be used to access the AR experience.

Business value:

  • Allows customers to visualize products in their actual environment before purchase
  • Reduces returns by setting accurate expectations of product size and appearance
  • Creates engaging marketing experiences that drive conversion
  • Provides sales teams with powerful visualization tools for client meetings

Returns​

Promise<Nullable<string>>

Promise resolving to an AR shortcode string, or null if generation fails

Example​

// Add a "View in your space" AR button to your product page
document.getElementById('view-in-ar').addEventListener('click', () => {
  window.mimeeqApp.actions.generateAR().then(shortcode => {
    if (shortcode) {
      window.location.href = `/ar-viewer?code=${shortcode}`;
    }
  });
});