Skip to Content

Read your models

Read everything we deliver for one article in one call.

An asset is everything we deliver for one article: its status, the 3D files, the viewer and AR links, the embed snippet and the images.

Read one article

GET/api/v1/assets/{article}assets:read
curl -sS https://platform.charpstar.co/api/v1/assets/CH-1001 \
  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Resultlive from our Demo companyOpen
The viewer behind viewerUrl. Drag to turn the model.

The status of the article is explained on the Status page.

Links are null until the product is delivered. The file links are stable: when we update a model, the link stays the same and the file behind it changes. The CDN serves ETag and Last-Modified, so you can tell when the file has changed.

The reference page lists every field of an asset.

Images

images lists the product images we have made for the article. The first one is the suggested main image. When images are added, replaced or removed, you get asset.images.updated.

The reference page lists every field of an image.

On this page