Skip to Content

Approve models from your own tool

Receive the review request, show the model to your reviewer and send the verdict back to us.

You end up with a review step inside your own tool: your reviewer sees the model and approves it or sends it back with comments. Approving publishes the model, exactly as approving in your CharpstAR account does.

Receive review.requested

When a model has passed our quality check, it waits for your approval and we send review.requested. Listen for status changes shows a receiver.

{
  "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "type": "review.requested",
  "occurredAt": "2026-10-20T09:31:00.000Z",
  "client": {
    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
    "name": "Your Company"
  },
  "article": "CH-1001",
  "data": {
    "articleId": "CH-1001",
    "reviewUrl": "https://platform.charpstar.co/client-review/3f2a1b0c-4d5e-4f6a-8b7c-9d0e1f2a3b4c"
  }
}

reviewUrl opens the model in your CharpstAR account.

Show the model to your reviewer

Give your reviewer the reviewUrl from the event. It opens the model that is waiting, in your CharpstAR account. Keep the article from the event: the verdict is sent for that article number.

The links on the asset (viewerUrl, glbUrl) are null until the product is delivered, so they do not show a model that is still in review.

Send the verdict

POST/api/v1/products/{article}/reviewreviews:write

decision is approve or request_changes. A model that is not waiting for you answers 409 not_ready.

To approve:

const res = await fetch(`https://platform.charpstar.co/api/v1/products/CH-1001/review`, {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({ decision: "approve" }),
});
console.log(res.status); // 200 reviewed, 409 when the model is not waiting for you

The answer:

{
  "articleId": "CH-1001",
  "decision": "approve",
  "status": "approved",
  "reviewedAt": "2026-10-21T14:02:00.000Z"
}

asset.approved follows once the files are live. A product with variants is approved with all of them.

To request changes, send at least one comment. Each comment has text and an optional imageUrl, an https link to a photo or drawing that shows it. We copy the image to your account.

curl -sS -X POST https://platform.charpstar.co/api/v1/products/CH-1001/review \
  -H "Authorization: Bearer $CHARPSTAR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "decision": "request_changes", "comments": [{ "text": "The seat is too thick", "imageUrl": "https://example.com/seat.jpg" }] }'

The answer:

{
  "articleId": "CH-1001",
  "decision": "request_changes",
  "status": "in_production",
  "reviewedAt": "2026-10-21T14:02:00.000Z"
}

From the third change request on the same model, extra revisions will likely be charged, so that request is made in your CharpstAR account, where you confirm it; the API answers 409 not_ready.

On this page