{
"description": null,
"favicon": "https://zylalabs.com/favicon.ico",
"image": null,
"siteName": "zylalabs.com",
"title": "Just a moment...",
"url": "https://zylalabs.com/"
}
curl --location --request GET 'https://zylalabs.com/api/13352/link+preview+-+url+unfurl+api/28457/preview?url=https://zylalabs.com' --header 'Authorization: Bearer YOUR_API_KEY'
{
"results": [
{
"description": "Stripe is a financial services platform that helps all types of businesses accept payments, build flexible billing models, and manage money movement.",
"favicon": "https://images.stripeassets.com/fzn2n1nzq965/1hgcBNd12BfT9VLgbId7By/01d91920114b124fb4cf6d448f9f06eb/favicon.svg",
"image": "https://images.stripeassets.com/fzn2n1nzq965/XtX984S1GJVsVOXFC7kMu/01988281e867728dfb09aa7793a6e3b9/Stripe.jpg?q=80",
"siteName": "stripe.com",
"title": "Stripe | Financial Infrastructure to Grow Your Revenue",
"url": "https://stripe.com/"
},
{
"description": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.",
"favicon": "https://github.com/fluidicon.png",
"image": "https://images.ctfassets.net/8aevphvgewt8/4pe4eOtUJ0ARpZRE4fNekf/f52b1f9c52f059a33170229883731ed0/GH-Homepage-Universe-img.png",
"siteName": "GitHub",
"title": "GitHub · Change is constant. GitHub keeps you ahead.",
"url": "https://github.com/"
}
]
}
curl --location --request POST 'https://zylalabs.com/api/13352/link+preview+-+url+unfurl+api/28458/preview+batch' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"urls": [
"https://stripe.com",
"https://github.com"
]
}'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Link Preview - URL Unfurl API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Trusted by leading companies
Give your app the rich link previews users expect — the cards Slack, iMessage, and Twitter show when you paste a URL. Send any URL, get back clean JSON with the page's title, description, preview image, site name, and favicon.
How it works: the API fetches the page server-side and reads OpenGraph tags first, then Twitter Card tags, then falls back to plain HTML (, meta description), so you get useful results even from pages with no social tags. Fetches are SSRF-safe (private/internal addresses blocked), size- and time-capped, and results are cacheable for an hour.
Endpoints: GET /preview?url=... for one URL; POST /preview/batch for up to 10 URLs in a single call. Errors use standard problem-details JSON with clear machine-readable codes.
Built for: chat and messaging apps, CMSs, social schedulers, read-later tools, forums — anywhere a pasted link should become a card.
The GET /preview endpoint returns a rich preview card containing the title, description, image, site name, favicon, and URL of the provided link. The POST /preview/batch endpoint returns similar data for up to 10 URLs in a structured format, allowing for batch processing of link previews.
Key fields in the response data include "title," "description," "image," "siteName," "favicon," and "url." These fields provide essential information about the linked page, enabling users to create rich previews.
The response data is organized in JSON format. For the GET endpoint, it returns a single object with fields for the link preview. The POST endpoint returns an object containing a "results" array, where each entry corresponds to a URL and includes its respective preview data.
Each endpoint provides information such as the page title, description, preview image, site name, favicon, and the original URL. This data helps users generate visually appealing link previews for various applications.
Users can customize their requests by specifying the URL parameter in the GET request or by providing an array of URLs in the POST request. This flexibility allows users to retrieve previews for specific links or multiple links in one call.
The API fetches data from the target webpage by reading OpenGraph tags, Twitter Card tags, and HTML meta descriptions. This multi-source approach ensures that users receive relevant information even if some tags are missing.
Typical use cases include generating link previews for chat and messaging apps, content management systems, social media schedulers, and forums. This functionality enhances user experience by providing rich visual context for shared links.
If a URL returns partial or empty results, the API will still provide the available fields, such as the site name and favicon. Users can implement fallback logic in their applications to handle these cases gracefully, ensuring a consistent user experience.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund