---
title: "Get an app instance thumbnail"
method: GET
path: "/v1/app-instances/{id}/thumbnail"
tags: ["app-instances"]
---

# Get an app instance thumbnail

`GET /v1/app-instances/{id}/thumbnail`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/app-instances/{id}/thumbnail`
- Auth: HTTP bearer

Retrieve a shared preview image of an app instance. The same image is reused everywhere the app is previewed, so it loads quickly. Add `?fresh=1` to force a new image to be generated after a configuration change.

**Notes.**
- A cached image is `image/jpeg`. When there is none yet, the answer is a neutral `image/svg+xml` placeholder (header `x-brix-cache: pending`, not cached) while the image is drawn in the background; fetch it again shortly.

## Path parameters

- `id` string, required

## Query parameters

- `fresh` '1'

## Response `200`

Success. The body is the file itself.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No such app instance in this workspace.
- `503`: `browser_unavailable`: images cannot be drawn in this environment.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)