POST AI agent ready /v1/social-preview/extract

社交预览 API - 提取开放图谱和 Twitter 卡元标签

获取 URL 并提取 Open Graph 标签（og:title、og:description、og:image、og:type、og:site_name）、Twitter Card 标签（twitter:card、twitter:title、twitter:image、twitter:site、twitter:creator）和一般 HTML 元数据（标题、描述、规范、favicon）。返回针对丢失或格式错误的标签的警告。

Endpoint

Code examples

curl -X POST https://api.botoi.com/v1/social-preview/extract \
  -H "Content-Type: application/json" \
  -d '{"url":"https://github.com"}'

When to use this API

聊天和 CMS 平台中的链接预览卡

当用户将 URL 粘贴到您的应用程序中时，调用此端点以获取开放图谱数据并呈现包含标题、描述和图像的丰富链接预览卡。适用于 Slack 风格的链接展开。

社交分享的 SEO 审核

扫描您的页面以验证 Open Graph 和 Twitter Card 标签是否存在且格式正确。在共享活动上线之前捕获丢失的 og:image 标签或被截断的描述。

内容管理系统丰富

当编辑者向文章添加外部链接时，会从提取的元数据中自动填充链接标题、描述和缩略图。节省手动数据输入并保持预览卡一致。

Frequently asked questions

如果页面没有开放图谱标签会怎样？

og 部分针对缺失的标签返回空值。常规部分退回到 HTML <title> 和 <meta name="description"> 标记。为每个丢失的 OG 标签添加警告。

这是否遵循重定向？

是的。端点最多遵循 5 个重定向并从最终目标 URL 中提取元数据。

我可以从需要 JavaScript 的页面中提取元数据吗？

否。端点获取原始 HTML 响应。通过 JavaScript 注入 OG 标签的单页应用程序将返回不完整的元数据。服务器渲染的页面工作正常。

返回的常见警告有哪些？

警告包括缺少 og:title、缺少 og:image、超过 200 个字符的 og:description、缺少 Twitter Card 标签以及返回非图像内容类型的 og:image URL。

og:image URL 是否经过验证？

端点按原样从 HTML 返回 og:image URL。它不会获取图像来验证其存在或检查其尺寸。使用单独的 HEAD 请求来验证图像 URL。

Get your API key

Free tier includes 5 requests per minute with no credit card required. Upgrade for higher limits.