Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The language of the user
Body
Request to generate a link preview
Source of the link preview request
API
, WEB
Only available to enterprise customers working on integrations. Every link is guaranteed fresh, this is just for debugging timing issues.
true
, false
Only available to enterprise customers working on integrations. Every link is guaranteed fresh, this is just for debugging timing issues.
true
, false
Response
Successfully retrieved link preview
Complete information about a link and its associated content
Unique identifier for the link
Whether the link is valid
Last update timestamp
Original URL
Domain name from the URL
Type of content the link represents
UNKNOWN
, IMAGE
, VIDEO
, AUDIO
, DOCUMENT
, TEXT
, PAGE
, YOUTUBE_USER
, X_USER
, X_POST
, INSTAGRAM_USER
, INSTAGRAM_POST
, YOUTUBE_VIDEO
, AMAZON_PRODUCT
, ETSY_PRODUCT
, REDDIT_USER
, REDDIT_POST
, REDDIT_SUBREDDIT
, TIKTOK_USER
, TIKTOK_VIDEO
, GITHUB_REPOSITORY
HTTP status code
Whether the URL was redirected
Optional identifier for tracking the request
Content size in bytes
Final URL after redirects
Number of redirects
Redirect URL
Page title (only missing when ok: false)
Page description (only missing when ok: false)
Content language code
Information about a website icon/favicon
Collection of differently sized versions of an image
Detailed information about a video file
Detailed information about an audio file
Detailed information about a document
Information about plain text content
Information about a web page
Information about a YouTube video
Information about a YouTube channel
Information about an X (formerly Twitter) user
Information about an X (formerly Twitter) post
Information about an Instagram user
Information about an Instagram post
Information about an Amazon product
Information about an Etsy product
Information about a TikTok user
Information about a TikTok video
Information about a Reddit user
Information about a Reddit subreddit
Information about a Reddit post
Detailed information about a GitHub repository