---
title: "Set or generate a media poster"
method: POST
path: "/v1/media/{id}/poster"
tags: ["media"]
---

# Set or generate a media poster

`POST /v1/media/{id}/poster`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/media/{id}/poster`
- Auth: HTTP bearer

Attach a poster image to a media asset, used as its thumbnail. The file must be an image and no larger than 4 MB.

**Notes.**
- With `?generate=1` the body is `{ thumbnailUrl, generated }` and no request body is read.

## Path parameters

- `id` string, required

## Query parameters

- `generate` '1'

## Response `200`

Success.

- object
  - `data` union, required
    - object
      - `thumbnailUrl` string, nullable, required
      - `generated` boolean, required: False when no poster could be made (the previous one is kept).
    - object
      - `thumbnailUrl` string, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No media with this id.
- `413`: Over 4 MB.
- `415`: Not a recognised image.
- `422`: Empty body.
- `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)