Image output and links

What a render produces

Upscaling

A render request can ask for an upscaled image with upscale: true. It costs no extra credit. Each render then reports what became of it in upscale_status:

A failed or cancelled render has no image, so its upscale_status is null.

Signed image links

• Every image link is a full https URL, signed, and lasts at least 30 days.
• Each time you fetch a render, its link is signed afresh, so Retrieve a render always gives you a working one.
• Anyone who has a link can open the image until it expires, without a key. Share links only where you would share the image.

Download and store images

Download the image as soon as its render completes, and keep the render’s id beside it:

import { writeFile } from "node:fs/promises";

async function saveImage(render) {
  const response = await fetch(render.image_url);

  if (!response.ok) {
    throw new Error(`Could not download ${render.id}: ${response.status}`);
  }

  await writeFile(`renders/${render.id}.png`, Buffer.from(await response.arrayBuffer()));
}

The image link needs no key. If a download fails because the link has expired, fetch the render again and use the new link.

Scene and product images

Scenes and products carry an image_url too: the scene’s room picture, and the product’s own image. Links to images stored with us are signed in the same way. A product image that lives on your own website is returned as the address you gave it.

Ownership and use

Renders made from your content are yours: the Terms of service say so. They also appear in your workspace’s gallery in the app, marked as made by the API.