Introduction

Viewrium turns product photos, a video, a product page URL, or an existing 3D file into a set of catalog images, a GLB model, and a cross-platform 3D/AR viewer you can embed anywhere. This is the developer documentation for the public /v1 REST API, the official SDKs, the embed web component, and webhooks.

The pieces

• REST API - a single JSON API at https://api.viewrium.com/v1. The resource is a product: POST /v1/products takes images, a video, a product URL, or a finished model, and produces the product's images and its 3D model.
• SDKs - viewrium (Python, on PyPI) and @viewrium/sdk (JavaScript/TypeScript, on npm). Both are typed, thin wrappers over the same /v1 API.
• Embed - the <viewrium-model> web component, served from https://cdn.viewrium.com/v1/embed.js. Drop it on any page to render the 3D/AR viewer.
• Webhooks - HMAC-signed events (product.completed, product.failed) so you learn when a run finishes without polling.

Quote first, then commit

The one thing to know before you write any code: a fresh POST /v1/products never generates anything. It runs the analysis, prices the work, and parks - nothing is written, no product exists - returning a plan and a resume_token. You commit by posting that token back. See How generation works.

Authentication in one line

Every request is authenticated with an API key sent as Authorization: Bearer <key>. Secret keys (sk_) run server-side; publishable keys (pk_) are origin-gated and power the browser embed. See Authentication for the full model.

Next steps

• Quickstart - get a key and create your first product.
• How generation works - sources, the park/commit gate, and the product lifecycle.
• Guides - task-focused recipes for each source type.
• API reference - the full /v1 surface.

Shopify: the Viewrium Shopify app is coming soon. Until it ships, use the API and the embed component directly.