Link Preview - URL Unfurl API

API ID 13352

Turn any URL into a rich preview card — title, description, image, site name, and favicon — in one fast call. OpenGraph + Twitter Card fallbacks, SSRF-safe, batch support.

88 ms avg response

API Documentation

Endpoints

Request
Turn any URL into a rich preview card — title, description, image, site name, and favicon — in one fast call. OpenGraph + Twitter Card + HTML fallbacks, SSRF-safe.
Endpoint ID: 28457
GET https://zylalabs.com/api/13352/link+preview+-+url+unfurl+api/28457/preview
INPUT PARAMETERS

Preview — Endpoint Features

Object Description
url Required A single URL, example: https://zylalabs.com

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
API EXAMPLE RESPONSE
JSON
{
    "description": null,
    "favicon": "https://zylalabs.com/favicon.ico",
    "image": null,
    "siteName": "zylalabs.com",
    "title": "Just a moment...",
    "url": "https://zylalabs.com/"
}
Preview — CODE SNIPPETS

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' 


    
Request
Turn a batch of up to 10 URLs into a rich preview cards — title, description, image, site name, and favicon — in one fast call. OpenGraph + Twitter Card + HTML fallbacks, SSRF-safe.
Endpoint ID: 28458
POST https://zylalabs.com/api/13352/link+preview+-+url+unfurl+api/28458/preview+batch
INPUT PARAMETERS

Preview batch — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{
    "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/"
        }
    ]
}
Preview batch — CODE SNIPPETS

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"
  ]
}'

    

API Access Key & Authentication

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.

Headers
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 🎉)

🚀 Enterprise Plan

Starts at
$ 10,000/Year


  • Custom Volume
  • Custom Rate Limit
  • Specialized Customer Support
  • Real-Time API Monitoring
zeiss-logo amazon-logo zoom-logo decathlon-logo

Trusted by leading companies

Overview

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.

Link Preview - URL Unfurl API FAQs

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.

General FAQs

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.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

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.

The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

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.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund


Related APIs


You might also like