Skip to content

CHILI GraFx Environment API: Multi-layout template previews

CHILI GraFx icon

✨ New & Improved

Previews for a specific layout and page

All layouts of a multi-layout template previewed side by side

A GraFx Studio template can contain multiple layouts — variants of the same template at different sizes or intents — and each layout can have multiple pages. Until now, the template preview endpoint always returned the preview of the default layout and page only. You can now request a preview for any specific (layout, page) combination of a multi-layout template, which unlocks per-layout and per-page preview thumbnails in downstream applications such as GraFx Experience.

What this enables

Integrators and ISVs can use this to build experiences around a design system delivered as a single multi-layout template — one template that holds all the variants of a campaign, asset, or brand artifact (different sizes, channels, or page sequences). Instead of showing end users a single thumbnail and leaving them to guess at the rest, a portal can now render a thumbnail for every variant the design system contains, so the end user can preview and visually compare each layout and page before picking the one they want to personalize or export.

The API change

Two endpoints accept two new optional query parameters — layoutId and pageId:

GET /api/v1/environment/{environment}/templates/{templateId}/preview

GET /api/v1/environment/{environment}/templates/{templateId}/preview/{previewType}

Behavior:

  • Both parameters are optional and fully backwards-compatible — when both are omitted, the endpoint returns the default-layout / default-page preview, exactly as before.
  • When either is provided, the preview is rendered (or served from cache) for that specific (layout, page) combination.
  • When either is provided but the resolved rendering engine version is below 2.24.0, the endpoint returns 400 Bad Request with a message indicating the minimum supported engine version.

More info

Read more in the Developer Center