v1

latestOpenAPI 3.0.02026-07-131310.1 KB

API Request

Get link preview

Get a link preview

get/

Query parameters

qstring required

URL to inspect

keystring required

Your API Key

fieldsstring

Comma-separated list of fields to return. See fields.

Response

successful response

titlestring required

Website title. Available on all plans.

descriptionstring required

Description summary. Available on all plans.

imagestring required

Preview image URL. Available on all plans.

urlstring required

Destination URL. Available on all plans.

Example response

{
  "title": "Google",
  "description": "Search webpages, images, videos and more.",
  "image": "https://www.google.com/images/logo.png",
  "url": "https://www.google.com"
}

All 1 operations