Get a preview

{
  "id": "jd7e8r1qxqnm3gz7e3awx1ypn18fv15j",
  "object": "preview",
  "status": "succeeded",
  "space": "interior",
  "surfaces": [
    {
      "surface": "Walls",
      "brand": "Sherwin-Williams",
      "color_name": "Agreeable Gray",
      "color_code": "SW 7029",
      "hex": "#D1CBC1"
    }
  ],
  "image_url": "https://...",
  "image_url_expires_at": "2026-10-14T22:28:38.783Z",
  "error": null,
  "upscale": null,
  "created_at": "2026-10-07T22:28:21.028Z"
}

statusstring

One of queued, processing, succeeded, or failed.

surfacesarray

Each painted surface with its brand, color_name, color_code, and hex.

image_urlstring or null

A link to the finished image. It is null until the status is succeeded.

image_url_expires_atstring or null

When the image link stops working.

errorstring or null

Why the preview failed, when it did.

upscaleobject or null

The 4K version, with its own status, image_url, image_url_expires_at, and error. It is null until you ask for one.

An image link works for seven days, and every request returns a current one. Download the image and store it on your side if you need it for longer. We keep the image until you delete the preview.