POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

accept-language
string

The language of the user

Body

Request to generate a link preview

forceNewSnapshot
enum<string>
default:
true

Only available to enterprise customers working on integrations. Every link is guaranteed fresh, this is just for debugging timing issues.

Available options:
true,
false
forceNewSnapshotRecursive
enum<string>
default:
true

Only available to enterprise customers working on integrations. Every link is guaranteed fresh, this is just for debugging timing issues.

Available options:
true,
false
source
enum<string>
default:
API

Source of the link preview request

Available options:
API,
WEB

Response

200 - application/json

Complete information about a link and its associated content

domain
string
required

Domain name from the URL

id
number
required

Unique identifier for the link

ok
boolean
required

Whether the link is valid

redirected
boolean
required

Whether the URL was redirected

status
number
required

HTTP status code

type
enum<string>
default:
UNKNOWN
required

Type of content the link represents

Available options:
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
updatedAt
string
required

Last update timestamp

url
string
required

Original URL

amazonProduct
object

Information about an Amazon product

audio
object

Detailed information about an audio file

description
string

Page description (only missing when ok: false)

document
object

Detailed information about a document

etsyProduct
object

Information about an Etsy product

githubRepository
object

Detailed information about a GitHub repository

icon
object

Information about a website icon/favicon

image
object

Collection of differently sized versions of an image

instagramPost
object

Information about an Instagram post

instagramUser
object

Information about an Instagram user

language
string

Content language code

page
object

Information about a web page

redditPost
object

Information about a Reddit post

redditSubreddit
object

Information about a Reddit subreddit

redditUser
object

Information about a Reddit user

redirectionCount
number

Number of redirects

redirectionTrail
string[]
redirectionUrl
string

Final URL after redirects

requestId
string

Optional identifier for tracking the request

size
number

Content size in bytes

text
object

Information about plain text content

tiktokUser
object

Information about a TikTok user

tiktokVideo
object

Information about a TikTok video

title
string

Page title (only missing when ok: false)

video
object

Detailed information about a video file

xPost
object

Information about an X (formerly Twitter) post

xUser
object

Information about an X (formerly Twitter) user

youtubeUser
object

Information about a YouTube channel

youtubeVideo
object

Information about a YouTube video