Documentation

Everything you need to install, configure, and get the most out of suPixel AI Try On.

Installation

suPixel AI Try On is a standard WordPress plugin. Download the .zip file and install via Plugins → Add New → Upload Plugin in your WordPress admin.

Requirements

  • WordPress 5.8 or higher
  • WooCommerce (active)
  • PHP 7.4 or higher

Quick Start

  1. Upload and activate the plugin
  2. A free licence with 10 credits is created automatically — no key entry needed
  3. A "Try It On" button appears on all product pages
  4. Visit suPixel → Settings to configure button style, categories, and languages

Configuration

All settings are found under suPixel → Settings in your WordPress admin.

Button Settings

SettingDescriptionDefault
Button TextLabel shown on the product page button"Try It On"
Button ColourBackground colour (hex)#6AADA8
Button PositionBefore or after the add-to-cart buttonAfter
Border RadiusCorner rounding in pixels0

Feature Toggles

ToggleDescription
Session GallerySave results in localStorage for 24 hours
SharingShow WhatsApp, download, and share buttons on results
WatermarkShow suPixel watermark on result images (forced on Free plan)
Studio ModeShow Studio/Try-On toggle (paid plans only)
Privacy ConsentShow GDPR consent screen before photo upload

Categories

suPixel supports 27 product categories, each with a specialised AI prompt. The plugin auto-detects the category from your WooCommerce product taxonomy, or you can set it manually per product.

GroupCategories
Fashiontops, bottoms, dresses, outerwear, shoes
Accessorieswatches, nails, hair, jewellery, eyewear, accessories
Automotivewheels, car_parts, car_wraps, number_plates
Homedoors, windows, furniture, flooring, wallpaper, lighting, curtains
Techphone_cases, laptop_skins
Generalgeneral (fallback)

Studio Mode

Studio Mode creates professional editorial portraits instead of editing the original photo. Available on paid plans (Starter, Growth, Pro, Enterprise). Costs 2 credits per generation.

Studio Mode uses professional studio lighting (key + rim + fill), an 85mm lens feel with shallow depth of field, and luxury fashion colour grading.

Direct Upload Architecture

Photos go directly from the customer's browser to api.supixel.ai using HMAC-SHA256 signed tokens. This bypasses your server, WAF, and file size limits.

Flow

  1. Customer uploads photo in the modal
  2. Lightweight AJAX to WordPress — sends product ID, gets back a signed token
  3. Browser sends photo + token directly to the cloud API
  4. API validates signature, generates image, returns CDN URL

If the direct upload fails (CORS issue, network error), the plugin automatically falls back to the server-side admin-ajax.php route.

When enabled, results are saved in the customer's browser (localStorage) for 24 hours. A thumbnail strip below the result lets customers browse previous try-ons without re-generating.

Sharing

Result images can be shared via WhatsApp, native mobile sharing (navigator.share), copied to clipboard, or downloaded directly. All sharing text is translated into the active language.

Languages

The plugin includes 7 translations: English, Turkish, Arabic (with RTL), German, Spanish, French, Italian, and Dutch. Every UI string is translatable — modal buttons, consent text, loading states, error messages, and share messages.

API Reference

The suPixel cloud API is at https://api.supixel.ai/v1. Pro plan subscribers get REST API access for custom integrations.

MethodEndpointDescription
GET/v1/healthHealth check
GET/v1/credits/balanceGet credit balance
POST/v1/try-on/generateGenerate try-on image
POST/v1/licence/registerRegister new free licence
POST/v1/licence/validateValidate licence key
POST/v1/checkout/sessionCreate Stripe checkout

Authentication

API requests use Authorization: Bearer <licence_key>. The generate endpoint also accepts HMAC-SHA256 signed tokens for browser-direct uploads.

Troubleshooting

Button not appearing

Ensure WooCommerce is active and the plugin is activated. Check that your product has an image. The button only appears on single product pages.

Generation fails

Check your credit balance in suPixel → Dashboard. If credits are available, check your server's PHP error log for AJAX errors. The plugin will fall back to server-side upload if direct upload fails.

CORS errors in console

The direct upload requires CORS headers from api.supixel.ai. If you see CORS errors, the plugin automatically falls back to the server-side route. Contact support if the fallback also fails.