コンテンツへスキップ
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 メタデータ (タイトル、説明、カノニカル、ファビコン) を抽出します。 タグが欠落しているか不正な形式である場合に警告を返します。

Parameters

stringrequired

URL to extract social preview metadata from.

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 をアプリに貼り付けると、このエンドポイントを呼び出して Open Graph データを取得し、タイトル、説明、画像を含むリッチ リンク プレビュー カードをレンダリングします。 Slack スタイルのリンク展開に機能します。

ソーシャル共有のためのSEO監査

ページをスキャンして、Open Graph タグと Twitter Card タグが存在し、正しくフォーマットされていることを確認します。 共有キャンペーンを開始する前に、欠落している og:image タグや切り詰められた説明を見つけます。

コンテンツ管理システムの強化

編集者が記事に外部リンクを追加する場合、抽出されたメタデータからリンクのタイトル、説明、サムネイルが自動入力されます。 手動のデータ入力を節約し、プレビュー カードの一貫性を保ちます。

Frequently asked questions

ページに Open Graph タグがない場合はどうなりますか?
og セクションは、タグが欠落している場合は null 値を返します。 一般セクションは、HTML の <title> タグと <meta name="description"> タグに戻ります。 OG タグが欠落しているたびに警告が追加されます。
これはリダイレクトに従いますか?
はい。 エンドポイントは最大 5 つのリダイレクトを追跡し、最終的な宛先 URL からメタデータを抽出します。
JavaScript を必要とするページからメタデータを抽出できますか?
いいえ。エンドポイントは生の HTML 応答を取得します。 JavaScript 経由で OG タグを挿入するシングルページ アプリケーションは、不完全なメタデータを返します。 サーバーでレンダリングされたページは正しく動作します。
返される一般的な警告は何ですか?
警告には、og:title の欠落、og:image の欠落、200 文字を超える og:description、Twitter カード タグの欠落、および画像以外のコンテンツ タイプを返す og:image URL が含まれます。
og:image URL は検証されていますか?
エンドポイントは、og:image URL を HTML からそのまま返します。 イメージをフェッチして存在を確認したり、サイズをチェックしたりすることはありません。 別の HEAD リクエストを使用して画像 URL を検証します。

Get your API key

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