Skip to content

Overview

The legacy Microlink Embed SDK is no longer maintained. It keeps working and you can still use it, but it won't receive further updates. The new Microlink SDK — the microlink.io package — is the way to consume the Microlink API going forward.
Microlink SDK is the way to consume Microlink API directly from your UI, enabling beautiful link previews for any link, designed with three things in mind:
  • Common surface: Although they may have different interface API, every specific integration has the same functionalities.
  • Lightweight & fast: The bundle size tends to be equal or less than 10KB (no polyfills included).
  • Customizable style: At least you can customize style using universal CSS classes present on the markup.
You can convert any link present in your markup
into a beautiful preview
Microlink SDK can detect video, audio or image automagically. Also, it supports some customizable things, like size.
or resolve into embed when is possible:
The following steps show you how to integrate Microlink SDK in your site, no matter what web stack you have.