virtual-try-on) and interior (room-visualizer) — over a REST API.
Base URL
Conventions
- Format: JSON for requests and responses.
- Auth: API key as a Bearer token (see Authentication).
- Delivery: asynchronous — webhooks by default, polling optional.
- Versioning: the version is part of the URL (
/v1). Backwards-incompatible changes ship under a new version.
OpenAPI spec
The published OpenAPI 3.1 contract is served live by the API:Quickstart
- Create an API key in the dashboard under Account → API Keys.
- Register a webhook endpoint so you can receive results.
- Create a generation with a customer photo and 1–3 products.
- Verify the signature on incoming webhook events and use the
imageUrlfrom the payload — or pick a smallerimageVariants.{list,card,detail}URL when you’re embedding in emails, lists, or mobile.
Requirements
- The public API requires an active subscription. Requests from organizations without one return
403 subscription_required. - Each API key is scoped to a single store within your organization; every generation it creates is attributed to that store.
- Keys are rate limited — see Rate limits.
Billing
Each completed generation consumes credits based onimageSize:
| Size | Credits |
|---|---|
1K (default) | 1 |
2K | 2 |
4K | 3 |