Skip to content

Fetch link preview (cached)

GET
/api/v1/links/preview
curl --request GET \
--url 'http://localhost:3001/api/v1/links/preview?url=example' \
--header 'Authorization: <Authorization>'

Return a cached link-preview record if one exists.

url
required
string

URL to preview

OK

Media typeapplication/json
object
key
additional properties
any
Examplegenerated
{}

Unauthorized

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Internal Server Error

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}