headers
PRO

Type: <object>
It sets any HTTP header that will be passed along over the url.
  • CLI
  • JavaScript
  • Shell
  • Python
  • Ruby
const mql = require('@microlink/mql')

const { status, data } = await mql('https://news.ycombinator.com', { headers: {'user-agent': 'googlebot', 'accept-language': 'en-US'} })

mql.render(data)
Passing headers must the way to authenticate a non-public target URL, providing the necessary headers to make it reachable for Microlink API.
One consideration to keep in mind is that values provided will be passed as query parameters, meaning anyone can see them since they are public.
In case you are treating with sensible headers (e.g.,
authorization
 or
cookie
) you can pass them as part of the request headers rather than query parameters.
For doing that, pass the header with x-api-header-* key prefix:
curl -G https://api.microlink.io \
  -d url=https://test-http-login.vercel.app \
  -d screenshot=true \
  -d embed=screenshot.url \
  -H 'x-api-header-authorization: Basic YWRtaW46YWRtaW4='
In that way, they will be not publicly exposed.