media

Set or generate a media poster

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.
post/v1/media/{id}/poster

Request

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

Path parameters

idstring required

Media asset id.

Query parameters

generate'1'

1: generate the poster from the media itself (send no body).

Response

Success.

Changes

No recorded changes to this operation across all 2 revisions of this API.