getLayoutPreviewImage

GET

/api/v1/layouts/{id}/preview-image

const url = 'https://example.com/api/v1/layouts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preview-image';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/layouts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preview-image

Serves the authenticated, frozen JPEG captured from the real Layout editor canvas.

Parameters

Path Parameters

required

string format: uuid

Responses

200

Current Layout preview JPEG

application/octet-stream

string format: binary

404

Layout or preview image not found