{
"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"}'
注册后,每个开发者都会被分配一个个人 API 访问密钥,这是一个唯一的字母和数字组合,用于访问我们的 API 端点。要使用 链接预览展开 API 进行身份验证,只需在 Authorization 标头中包含您的 bearer token。
| 标头 | 描述 |
|---|---|
授权
|
必需
应为 Bearer access_key. 订阅后,请查看上方的"您的 API 访问密钥"。
|
将 URL 展开为 Open Graph 和 Twitter Card 元数据以及网站图标。目前无法截取屏幕截图;完全支持元数据预览
它会返回聊天应用或内容管理系统在链接下方显示的标题、描述、图片、网站名称、网站图标、规范网址和卡片类型
它会先读取 Open Graph 和 Twitter Card 标签,然后回退到 HTML 标题和元描述
目前无法截取屏幕截图;完全支持元数据预览
在获取页面之前,私有主机、元数据地址和非 Web 端口会被拒绝
使用包含 X-Api-Key 的请求头发送 GET /v1/preview?url=https://github.com/。JSON 响应包含页面元数据和网站图标
它专为聊天应用、CMS 编辑器以及任何需要在粘贴的链接下方显示丰富卡片的产品打造
两个端点都会返回链接元数据。GET 端点通过查询参数接收目标 URL,而 POST 端点则通过 JSON 请求正文接收 URL。它们的预览数据使用相同的通用响应结构。
数据对象可以包含请求的 URL、最终 URL、HTTP 状态码、标题、描述、图像、网站名称、网站图标、规范 URL、内容类型、Twitter 卡片值和语言
Final_url 是经过重定向或其他导航变化后到达的 URL。将其与 url 进行比较,以确定原始地址是否重定向到了另一个页面
Canonical 包含页面声明的首选 URL(如果有)。language 标识检测到或声明的页面语言,例如“en”,帮助应用程序适当地标记或处理预览娱乐注册
先检查顶层的 ok 字段。成功时,使用 data 显示预览,并使用 status_code 获取页面的 HTTP 结果。还要检查字段是否缺少值,因为各个页面可能不会提供所有元数据元素。
Meta 对象包含请求诊断信息,例如 request_id、API 名称、版本、elapsed_ms 以及其他处理元数据。使用 request_id 将响应与日志或支持调查关联起来。
响应中的 image、site_name、favicon、canonical 或 twitter_card 等字段可能为空或缺失。应用程序应将这些字段视为可选项,并使用可用的标题、描述和 URL 回退到更简洁的显示方式
使用图片作为主要的富预览配图,并使用网站图标作为站点图标。两者均以 URL 形式返回,因此客户端可以在卡片或列表中展示它们,同时妥善处理资源缺失、无法访问或不适用的情况