{
"url": "https://github.com/",
"title": "GitHub · Change is constant. GitHub keeps you ahead. · GitHub",
"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.",
"image": "https://images.ctfassets.net/8aevphvgewt8/4pe4eOtUJ0ARpZRE4fNekf/f52b1f9c52f059a33170229883731ed0/GH-Homepage-Universe-img.png",
"siteName": "GitHub",
"themeColor": "#1e2327",
"favicon": "https://github.githubassets.com/favicons/favicon.svg",
"canonical": "https://github.com/",
"cached": true
}
curl --location --request GET 'https://zylalabs.com/api/13530/url+link+preview+api/30202/get+link+preview?url=https://github.com' --header 'Authorization: Bearer YOUR_API_KEY'
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 URL Link Preview 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.
An innovative API designed for seamless integration, enabling developers to interact with and manage various data processes efficiently.
The Get Link Preview endpoint returns metadata about a specified URL, including the title, description, Open Graph image, site name, theme color, favicon, and canonical URL. This data helps create rich link previews for applications.
Key fields in the response include "url," "title," "description," "image," "siteName," "themeColor," "favicon," and "canonical." Each field provides specific information about the target URL for effective link previews.
The response data is structured in JSON format, with each key-value pair representing a specific attribute of the URL. This organization allows for easy parsing and integration into applications.
The endpoint provides information such as the page title, description, Open Graph image, site name, theme color, favicon, and canonical URL. This data is essential for generating visually appealing link previews.
Users can customize their requests by specifying the target URL in the GET request. The API automatically extracts relevant metadata from the provided URL, allowing for tailored link previews based on the content of the page.
Data accuracy is maintained through the extraction of metadata directly from the target URL. The API caches results for one hour, ensuring that the information remains consistent and reliable during that period.
Typical use cases include creating link previews for chat applications, social media posts, bots, and no-code tools. This enhances user engagement by providing rich visual content alongside shared links.
If the API returns partial or empty results, users should check the target URL for valid metadata. Implementing error handling in the application can help manage such scenarios, ensuring a fallback or default display when data is missing.
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