Overview
Embed Viewa's AI product visualisation in your e-commerce storefront.
The Viewa E-commerce Visualisation API lets your product pages show customers what a window treatment looks like in their own home: they upload a photo, mark out the area to cover, pick a product and material, and receive an AI-generated composite of your product in their space.
Everything in the pipeline is asynchronous — you POST to create a resource and poll
its status until it's ready.
Build with an AI agent
These docs are written for coding agents as much as for people, and the fastest path to a working integration is usually to hand them to one:
- /llms.txt — a machine-readable index of every page, and /llms-full.txt — the entire documentation in one document. Point your agent at either to give it the full picture.
- Every page is available as raw Markdown — use the Copy Markdown button, or the Open menu to send a page straight to Claude or ChatGPT with context attached.
- The API reference is generated from our OpenAPI 3.1 specification, so an agent can rely on it being exact: paths, schemas, auth, and error codes match the live API.
The integration skill walks your coding agent through the whole implementation — keys, catalog wiring, widget embedding, and render handling — end to end, with verified checkpoints at every phase.
Two ways to integrate
Embed the widget
A framework-agnostic web component that handles upload, area editing, and render display. Your product customiser drives it through a small JS API.
Call the API directly
A REST API for full control: upload photos, define areas, request renders, and display results with your own UI.
Most integrations start with the widget — it ships the photo-upload and corner-editing UX so you don't have to build it. The raw API is there when you need complete control over the experience.