{
"ok": true,
"data": {
"url": "https://github.com",
"final_url": "https://github.com",
"status_code": 200,
"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/76epZKB2wF998m4e4bLLXn/c505f20b00ec70b88b1be5aec42c4be4/OG_image.jpg",
"site_name": "GitHub",
"favicon": "https://github.com/fluidicon.png",
"canonical": "https://github.com",
"type": "object",
"twitter_card": "summary_large_image",
"language": "en"
},
"meta": {
"request_id": "74494e4e82aa4879aa49a381209f3935",
"api": "link-preview",
"version": "1",
"elapsed_ms": 2177,
"llm_used": false,
"cache_hit": false,
"warnings": [],
"plan": null
}
}
curl --location --request GET 'https://zylalabs.com/api/15181/link+preview+unfurl+api/40591/preview+get?url=https://github.com' --header 'Authorization: Bearer YOUR_API_KEY'
{
"ok": true,
"data": {
"url": "https://github.com",
"final_url": "https://github.com",
"status_code": 200,
"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/76epZKB2wF998m4e4bLLXn/c505f20b00ec70b88b1be5aec42c4be4/OG_image.jpg",
"site_name": "GitHub",
"favicon": "https://github.com/fluidicon.png",
"canonical": "https://github.com",
"type": "object",
"twitter_card": "summary_large_image",
"language": "en"
},
"meta": {
"request_id": "42b5e2c3a7ee46d9ad148a81bd46bc06",
"api": "link-preview",
"version": "1",
"elapsed_ms": 2616,
"llm_used": false,
"cache_hit": false,
"warnings": [],
"plan": null
}
}
curl --location --request POST 'https://zylalabs.com/api/15181/link+preview+unfurl+api/40592/preview+post' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"url":"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 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.
Unfurl a URL into Open Graph and Twitter Card metadata plus a favicon. Screenshot capture is currently unavailable; metadata previews are fully supported.
It returns the title, description, image, site name, favicon, canonical URL and card type that a chat app or CMS shows under a link.
It reads Open Graph and Twitter Card tags first, then falls back to the HTML title and meta description.
Screenshot capture is currently unavailable; metadata previews are fully supported.
Private hosts, metadata addresses and non-web ports are rejected before the page is fetched.
Send GET /v1/preview?url=https://github.com/ with your X-Api-Key header. The JSON response contains the page metadata and favicon.
It is built for chat apps, CMS editors and any product that needs to show a rich card under a pasted link.
Both endpoints return link metadata. The GET endpoint receives the target URL as a query parameter, while the POST endpoint receives the URL in a JSON request body. Their preview data uses the same general response structure.
The data object can include the requested URL, final URL, HTTP status code, title, description, image, site name, favicon, canonical URL, content type, Twitter Card value, and language.
Final_url is the URL reached after redirects or other navigation changes. Compare it with url to identify whether the original address redirected to another page.
Canonical contains the page’s declared preferred URL when available. language identifies the detected or declared page language, such as "en", helping applications label or process previews appropriately.
Check the top-level ok field first. When successful, use data for the preview and status_code for the fetched page’s HTTP result. Also inspect fields for missing values because individual pages may not provide every metadata element.
The meta object contains request diagnostics such as request_id, API name, version, elapsed_ms, and other processing metadata. Use request_id to correlate a response with logs or support investigations.
The response may contain empty or missing values for fields such as image, site_name, favicon, canonical, or twitter_card. Applications should treat these fields as optional and fall back to simpler displays using the available title, description, and URL.
Use image as the primary rich-preview artwork and favicon as the site icon. Both are returned as URLs, so clients can render them in cards or lists while handling absent, inaccessible, or unsuitable assets gracefully.
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