link-preview

Preview a link

Return a preview image of a web page: a screenshot of the page, sized to the optional w and h, or a card with the site's icon when no screenshot can be made. The page is fetched on the server, only from public addresses, and the screenshot is kept for seven days.

Notes.

  • Answers an IMAGE, not JSON: a screenshot of the page (cached for 7 days and resized to w × h), or, when no capture can be made, an SVG card with the site's icon. It always answers 200 for an allowed address.
get/v1/link-preview

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/link-preview
  • Auth: HTTP bearer

Query parameters

urlstring required

An http(s) address on the public internet.

winteger

Width in pixels to size the image to.

hinteger

Height in pixels.

fitstring

How the image fits w × h (cover, contain, …).

Response

Success. The body is the file itself.

Changes

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