链接预览展开 API

API ID 15181

展开 URL 以获取 Open Graph 和 Twitter Card 元数据及网站图标。当前无法截取屏幕截图;完全支持元数据预览。

2,492 ms 平均响应

API 文档

端点

请求
返回作为查询参数传入的网页 URL 的 Open Graph 和 Twitter Card 元数据、网站图标及规范 URL
Endpoint ID: 40591
GET https://zylalabs.com/api/15181/link+preview+unfurl+api/40591/preview+get
输入参数

预览 获取 — 端点功能

对象 描述
url 必需 The full web page URL to preview, for example https://github.com.

剩余免费测试请求:3 / 3。


输入参数

url
API 示例响应
JSON
{
    "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' 


    
请求
返回通过 POST 以 JSON 请求体发送的 URL 的链接预览(标题、描述、图片、网站图标)
Endpoint ID: 40592
POST https://zylalabs.com/api/15181/link+preview+unfurl+api/40592/preview+post
输入参数

预览帖子 — 端点功能

对象 描述
请求体 必需 Json

剩余免费测试请求:3 / 3。


输入参数

API 示例响应
JSON
{
    "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 端点。要使用 链接预览展开 API 进行身份验证,只需在 Authorization 标头中包含您的 bearer token。

标头
标头 描述
授权 必需 应为 Bearer access_key. 订阅后,请查看上方的"您的 API 访问密钥"。

无长期承诺。随时升级、降级或取消。 免费试用包括最多 50 个请求。

起价
$10,000/年


  • 自定义数量
  • 自定义速率限制
  • 专业客户支持
  • 实时 API 监控

概览

将 URL 展开为 Open Graph 和 Twitter Card 元数据以及网站图标。目前无法截取屏幕截图;完全支持元数据预览

链接预览展开 API FAQs

它会返回聊天应用或内容管理系统在链接下方显示的标题、描述、图片、网站名称、网站图标、规范网址和卡片类型

它会先读取 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 形式返回,因此客户端可以在卡片或列表中展示它们,同时妥善处理资源缺失、无法访问或不适用的情况

一般常见问题

Zyla API Hub 就像一个大型 API 商店,您可以在一个地方找到数千个 API。我们还为所有 API 提供专门支持和实时监控。注册后,您可以选择要使用的 API。请记住,每个 API 都需要自己的订阅。但如果您订阅多个 API,您将为所有这些 API 使用相同的密钥,使事情变得更简单。
价格以 USD(美元)、EUR(欧元)、CAD(加元)、AUD(澳元)和 GBP(英镑)列出。我们接受所有主要的借记卡和信用卡。我们的支付系统使用最新的安全技术,由 Stripe 提供支持,Stripe 是世界上最可靠的支付公司之一。如果您在使用卡片付款时遇到任何问题,请通过 [email protected]

此外,如果您已经以这些货币中的任何一种(USD、EUR、CAD、AUD、GBP)拥有有效订阅,该货币将保留用于后续订阅。只要您没有任何有效订阅,您可以随时更改货币。
定价页面上显示的本地货币基于您 IP 地址的国家/地区,仅供参考。实际价格以 USD(美元)为单位。当您付款时,即使您在我们的网站上看到以本地货币显示的等值金额,您的卡片对账单上也会以美元显示费用。这意味着您不能直接使用本地货币付款。
有时,银行可能会因其欺诈保护设置而拒绝收费。我们建议您首先联系您的银行,检查他们是否阻止了我们的收费。此外,您可以访问账单门户并更改关联的卡片以进行付款。如果这些方法不起作用并且您需要进一步帮助,请通过 [email protected]
价格由月度或年度订阅决定,具体取决于所选计划。
API 调用根据成功请求从您的计划中扣除。每个计划都包含您每月可以进行的特定数量的调用。只有成功的调用(由状态 200 响应指示)才会计入您的总数。这确保失败或不完整的请求不会影响您的月度配额。
Zyla API Hub 采用月度订阅系统。您的计费周期将从您购买付费计划的那一天开始,并在下个月的同一日期续订。因此,如果您想避免未来的费用,请提前取消订阅。
要升级您当前的订阅计划,只需转到 API 的定价页面并选择您要升级到的计划。升级将立即生效,让您立即享受新计划的功能。请注意,您之前计划中的任何剩余调用都不会转移到新计划,因此在升级时请注意这一点。您将被收取新计划的全部金额。
要检查您本月剩余多少 API 调用,请参考响应标头中的 "X-Zyla-API-Calls-Monthly-Remaining" 字段。例如,如果您的计划允许每月 1,000 个请求,而您已使用 100 个,则响应标头中的此字段将显示 900 个剩余调用。
要查看您的计划允许的最大 API 请求数,请检查 "X-Zyla-RateLimit-Limit" 响应标头。例如,如果您的计划包括每月 1,000 个请求,此标头将显示 1,000。
"X-Zyla-RateLimit-Reset" 标头显示您的速率限制重置之前的秒数。这告诉您何时您的请求计数将重新开始。例如,如果它显示 3,600,则意味着还有 3,600 秒直到限制重置。
是的,您可以随时通过访问您的账户并在账单页面上选择取消选项来取消您的计划。请注意,升级、降级和取消会立即生效。此外,取消后,您将不再有权访问该服务,即使您的配额中还有剩余调用。
为了让您有机会在没有任何承诺的情况下体验我们的 API,我们提供 7 天免费试用,允许您免费进行最多 50 次 API 调用。此试用只能使用一次,因此我们建议将其应用于您最感兴趣的 API。虽然我们的大多数 API 都提供免费试用,但有些可能不提供。试用在 7 天后或您进行了 50 次请求后结束,以先发生者为准。如果您在试用期间达到 50 次请求限制,您需要"开始您的付费计划"以继续发出请求。您可以在个人资料中的订阅 -> 选择您订阅的 API -> 定价标签下找到"开始您的付费计划"按钮。或者,如果您在第 7 天之前不取消订阅,您的免费试用将结束,您的计划将自动计费,授予您访问计划中指定的所有 API 调用的权限。请记住这一点以避免不必要的费用。
7 天后,您将被收取试用期间订阅的计划的全额费用。因此,在试用期结束前取消很重要。因忘记及时取消而提出的退款请求不被接受。
当您订阅 API 免费试用时,您可以进行最多 50 次 API 调用。如果您希望超出此限制进行额外的 API 调用,API 将提示您执行"开始您的付费计划"。您可以在个人资料中的订阅 -> 选择您订阅的 API -> 定价标签下找到"开始您的付费计划"按钮。
付款订单在每月 20 日至 30 日之间处理。如果您在 20 日之前提交请求,您的付款将在此时间范围内处理。
您可以通过我们的聊天渠道联系我们以获得即时帮助。我们始终在线,时间为上午 8 点至下午 5 点(EST)。如果您在该时间之后联系我们,我们将尽快回复您。此外,您可以通过 [email protected]

相关 API