Skip to Content

Read one article

Needs the scope assets:read

Everything we deliver for one article: its status, the 3D files, the viewer and AR links, the embed snippet, images and variants. Links are null until the product is delivered. glbUrl and usdzUrl never change for an article; when a model is updated the file behind them changes, and the CDN serves ETag and Last-Modified so you can tell.

Path Parameters

article*string

Your article number.

Match^[A-Za-z0-9][A-Za-z0-9._\-]{0,63}$

Response Body

OK

application/json
  1. response
articleId*string
name*string
status*string

Where the product is. Build your logic on this value.

Value in"received""in_production""in_review""approved""delivered""cancelled"
statusDetail?string

With status received: we need something from you, usually references or dimensions.

deliveryDate*|

The planned delivery date, when there is one.

updatedAt*|null
glbUrl*|

The 3D model for web viewers and Android AR. Never changes for an article; the file behind it does.

usdzUrl*|

The model for AR on iPhone and iPad.

usdzReady*boolean

false for a short while after delivery, while the iPhone file is prepared.

thumbnailUrl*|null
viewerUrl*|

A hosted page with the interactive 3D view.

arUrl*|

One link that opens AR on any phone, and the 3D view on a computer.

embed*|null
images*array<>
variations*array<>
Example Request
curl -sS https://platform.charpstar.co/api/v1/assets/CH-1001 \  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Example Response
{  "articleId": "CH-1001",  "name": "Oslo lounge chair",  "status": "delivered",  "deliveryDate": "2026-10-20",  "updatedAt": "2026-10-20T09:30:00.000Z",  "glbUrl": "https://cdn.charpstar.net/YourCompany/Android/CH-1001.glb",  "usdzUrl": "https://cdn.charpstar.net/YourCompany/iOS/CH-1001.usdz",  "usdzReady": true,  "thumbnailUrl": "https://cdn.charpstar.net/YourCompany/Thumbnails/CH-1001.png",  "viewerUrl": "https://platform.charpstar.co/agent-viewer?glb=https%3A%2F%2Fcdn.charpstar.net%2FYourCompany%2FAndroid%2FCH-1001.glb&name=Oslo%20lounge%20chair&viewer=default",  "arUrl": "https://platform.charpstar.co/ar/0b6c9f0e-5d1a-4c47-9f4e-2a1d3c4b5e6f",  "embed": {    "dataClient": "YourCompany",    "dataArticleId": "CH-1001",    "snippet": "<script src=\"https://js.charpstar.net/V2/charpstAR-Base.js\" data-client=\"YourCompany\" data-language=\"en-gb\" defer></script>\n<charpstar-viewer data-articleid=\"CH-1001\"></charpstar-viewer>"  },  "images": [    {      "id": "8d2f4c1a-packshot",      "type": "packshot",      "variant": "Oak",      "url": "https://cdn.charpstar.net/YourCompany/Packshots/CH-1001-front.png",      "fileName": "CH-1001_packshot_front_1.png",      "width": 2048,      "height": 2048,      "bytes": 412331,      "createdAt": "2026-10-20T09:00:00.000Z",      "approved": true,      "primary": true,      "jobId": null    },    {      "id": "thumbnail:0b6c9f0e-5d1a-4c47-9f4e-2a1d3c4b5e6f",      "type": "thumbnail",      "variant": null,      "url": "https://cdn.charpstar.net/YourCompany/Thumbnails/CH-1001.png",      "fileName": "CH-1001_thumbnail_1.png",      "width": null,      "height": null,      "bytes": 88120,      "createdAt": "2026-10-20T08:55:00.000Z",      "approved": true,      "primary": false,      "jobId": null    }  ],  "variations": [    {      "articleId": "CH-1001-B",      "status": "in_production",      "thumbnailUrl": null,      "glbUrl": null    }  ]}

The result

An answer for a delivered article carries viewerUrl. This is that address for an article of our Demo company.

Resultlive from our Demo companyOpen
The viewer behind viewerUrl. Drag to turn the model.