API Parameters

url

Required
Type: string
The URL for which to retrieve Microlink data.

apiKey

Type: string
Default: undefined
The API Key used for authenticating your requests as x-api-key header.
The API endpoint where the request is made.

contrast

Type: boolean
Default: false
When enabled, it will generate a high contrast card based on predominant colors detected in the feature image from the provided url.

image

Type: string|array
Default: ['screenshot', 'image', 'logo']
Setup the image to use for the card.
The value will be determined the property to get from the API response. If you set up the value as an array of values, then they will be applied as fallback values until finding the first value that resolves.

is

Type: string
Default: 'a'
Determine the type of the root node element for rendering the card.

round

Type: boolean|string
Default: false
Determine if the card preview should have round corners or not.
If you provided a string value, it will be passed as the border-radius.

size

Type: string
Default: 'normal'
It determines the card layout. Currently we have two layouts supported:
  • 'normal' (default, no parameter required).
  • 'large'

prerender

Type: boolean|string
Default: auto
It determines the technique used to get content from the target URL.
Read more about prerender.

screenshot

Type: boolean|string
Default: false
Take a screenshot of the target url and use it as card image.

autoPlay

Type: boolean
Default: true
Determinate if the video will automatically start playing as soon as it can do so without stopping.

muted

Type: boolean
Default: true
It specifies that the audio output of the video should be muted.

loop

Type: boolean
Default: true
It specifies that the video will start over again, every time it is finished.