Description
Extract preview metadata through the unified scrape response
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | optional |
How to Use
1
1. Send a POST request to `/v1/scrape` with a `url`. 2. Include `extract: {"link_preview": true}`. 3. Read the preview metadata from the `link_preview` object.
About This Tool
Link Preview is now available through the unified scrape endpoint. Add `extract.link_preview: true` and the response includes OpenGraph, Twitter Card, favicon, and other preview-oriented metadata in a structured `link_preview` object.
This is ideal for building chat previews, bookmarks, social embeds, and lightweight metadata enrichment flows.
Why Use This Tool
- Chat apps — Render rich previews when users paste links
- CMS workflows — Auto-fill card title, description, and image
- Bookmark tools — Store thumbnails and site names with saved URLs
- SEO QA — Check whether OG and Twitter metadata are present
Frequently Asked Questions
Is this still a separate GET endpoint?
No. It is now one of the optional structured sections returned by `POST /v1/scrape`.
What if OG tags are missing?
The API falls back to other metadata sources when possible, but some fields may be null.
Does this support JS-rendered pages?
Yes — combine it with `render_js: true` when the target page relies on client-side rendering.
Start using Link Preview now
Get your free API key and make your first request in under a minute.