---
title: "overlays/model/{model}/preview"
method: GET
path: "/api/overlays/model/{model}/preview"
tags: ["overlays"]
---

# overlays/model/{model}/preview

`GET /api/overlays/model/{model}/preview`

Get the per-pixel virtual-display coordinates for a model, for a lightweight layout preview. Sourced from config/virtualdisplaymap (the xLights-exported layout) and returned on demand so the UI never has to inline this data (which can be hundreds of thousands of points per model) for every model at once.

## Response `200`

Object with a `pixels` array of [x, y, channel] triples.

## Changes

- **2026-07-14** `950d62762a6b` — 1 info
  - endpoint added
- **2026-05-13** `34a577bdabff` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/falconchristmas/apis/fpp-api/changes/api/overlays/model/:model/preview/get.md)

---

[API](https://skmtc.dev/falconchristmas/apis/fpp-api.md) · [All operations](https://skmtc.dev/falconchristmas/apis/fpp-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/falconchristmas/fpp-api/revisions/2d744b175449/schema)