URL Preview API

Extract rich metadata and generate link previews from any URL with our fast and reliable API.

Authentication

All API requests require an API key passed in the x-api-key header.

x-api-key: ek_your_api_key_here

Endpoint

POST /api/v1/unfurl

Extract metadata from a URL

Parameters

Parameter	Type	Required	Description
url	string	Yes	URL to extract metadata from
include_html	boolean	No	Include raw HTML in response (default: false)
timeout	number	No	Request timeout in ms (1000-15000, default: 5000)
follow_redirects	boolean	No	Follow HTTP redirects (default: true)

Response Fields

title - Page title

description - Meta description

image - Social media image URL

favicon - Site favicon URL

site_name - Website name

type - Open Graph type

canonical_url - Canonical URL

theme_color - Theme color

Example Response

1{
2  "success": true,
3  "data": {
4    "url": "https://github.com",
5    "final_url": "https://github.com/",
6    "title": "GitHub: Let's build from here",
7    "description": "GitHub is where over 100 million developers shape the future of software...",
8    "image": "https://github.githubassets.com/images/modules/site/social-cards/campaign-social.png",
9    "favicon": "https://github.githubassets.com/favicons/favicon.svg",
10    "site_name": "GitHub",
11    "type": "website",
12    "canonical_url": "https://github.com/"
13  },
14  "meta": {
15    "request_id": "req_u1v2w3",
16    "processing_ms": 320,
17    "remaining_credits": 97
18  }
19}

API Tester

URL *

cURL Command

curl -X POST 'https://preview.endpnt.dev/api/v1/unfurl' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://github.com",
  "include_html": false,
  "timeout": 5000,
  "follow_redirects": true
}' \
  | jq .