media

Render a web link now

Capture and store a screenshot of a web or link asset. If screenshot rendering is not available for this workspace, the response reports that it is not configured rather than failing.

Notes.

  • Usually queued (queued: true); the frame is then at GET /v1/media/{id}/render-frame.
  • A second request while a render of the same link with the same settings is still queued or running returns queued: true and adds nothing. After an edit, the request queues a render of the new settings.
post/v1/media/{id}/render

Request

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

Path parameters

idstring required

Media asset id.

Response

Success.

Changes

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