---
title: "Get a media poster image"
method: GET
path: "/v1/media/{id}/poster"
tags: ["media"]
---

# Get a media poster image

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

## Request

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

Return the poster image attached to a media asset, used as its thumbnail for videos and PDFs.

## Path parameters

- `id` string, required

## Query parameters

- `w` string
- `h` string
- `fit` 'cover' | 'contain' | 'scale-down' | 'crop' | 'pad'

## 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 media with this id, or it has no poster.
- `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)
