---
title: "Render a catalog app"
method: GET
path: "/v1/apps/{key}/render"
tags: ["apps"]
---

# Render a catalog app

`GET /v1/apps/{key}/render`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/apps/{key}/render`
- Auth: none required

Get the rendered HTML for one app from the app catalog. This is the same output used by the player and by the content management system preview.

**Notes.**
- HTML for an iframe, with a strict content security policy; who may frame it is limited to Brix players and the console.

## Path parameters

- `key` string, required

## Query parameters

- `config` string
- `lang` string
- `brand` string
- `dt` string

## Response `200`

Success. The body is the file itself.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `404`: Unknown app key. The body is still an HTML card saying so.
- `413`: `config` is over 8 KB.
- `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)