media

Create a media item

Create a media asset record for a file whose bytes are already stored elsewhere, by providing name, kind, and url. This creates only the metadata record; to upload new file bytes, use POST /v1/media/upload, PUT /v1/media/upload/:uploadId, or POST /v1/media/import-url instead.

Notes.

  • The 201 body is the row as written, not re-read: columns the create does not set are absent rather than null. GET returns every column.
  • Use this for links (web pages, streams, dashboards). To add a FILE, use POST /v1/media/upload, the multipart upload, or POST /v1/media/import-url.
post/v1/media

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/media
  • Auth: HTTP bearer

Request body

namestring required
kind'image' | 'video' | 'audio' | 'pdf' | 'powerpoint' | 'web' | 'dashboard' | 'weather' | 'rss' | 'clock' | 'qr' | 'menu' | 'directory' | 'donor-wall' | 'hall-of-fame' | 'birthday-board' | 'recognition' | 'wayfinding' | 'check-in' | 'emergency' | 'touch-kiosk' | 'package' | 'font' required
urlstring required

An https URL, a /v1/ path, or (for a web link) the page address. Private and internal network addresses are refused.

activeboolean
folderIdstring nullable
tagsstring[]
altTextstring nullable
thumbnailUrlstring nullable
widthinteger nullable
heightinteger nullable
durationSecnumber nullable
startsAtstring nullable
expiresAtstring nullable
autoArchiveOnExpiryboolean
qrobject nullable
webConfigobject nullable

Web link settings (refresh, zoom, …).

nodeIdstring nullable

Home location. Default: the caller's own location.

audioEnabledboolean
fit'contain' | 'cover' | 'fill' | 'blur-fill'

Response

Success.

Example response

{
  "data": {
    "id": "med_0c1d2e3f4a5b6c7d"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.