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

Social Preview API – Extrahieren Sie Open Graph- und Twitter-Card-Meta-Tags

Ruft eine URL ab und extrahiert Open Graph-Tags (og:title, og:description, og:image, og:type, og:site_name), Twitter Card-Tags (twitter:card, twitter:title, twitter:image, twitter:site, twitter:creator) und allgemeine HTML-Metadaten (Titel, Beschreibung, Canonical, Favicon). Gibt Warnungen für fehlende oder fehlerhafte Tags zurück.

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

Verknüpfen Sie Vorschaukarten in Chat- und CMS-Plattformen

Wenn ein Benutzer eine URL in Ihre App einfügt, rufen Sie diesen Endpunkt auf, um die Open Graph-Daten abzurufen und eine Rich-Link-Vorschaukarte mit Titel, Beschreibung und Bild zu rendern. Funktioniert für die Link-Entfaltung im Slack-Stil.

SEO-Prüfung für Social Sharing

Scannen Sie Ihre Seiten, um zu überprüfen, ob Open Graph- und Twitter Card-Tags vorhanden und korrekt formatiert sind. Erkennen Sie fehlende og:image-Tags oder abgeschnittene Beschreibungen, bevor Sharing-Kampagnen live geschaltet werden.

Erweiterung des Content-Management-Systems

Wenn Redakteure externe Links zu Artikeln hinzufügen, werden der Linktitel, die Beschreibung und die Miniaturansicht automatisch aus den extrahierten Metadaten ausgefüllt. Spart die manuelle Dateneingabe und sorgt dafür, dass die Vorschaukarten konsistent bleiben.

Frequently asked questions

Was passiert, wenn die Seite keine Open Graph-Tags hat?

Der og-Abschnitt gibt Nullwerte für fehlende Tags zurück. Der allgemeine Abschnitt greift auf die HTML-Tags <title> und <meta name="description"> zurück. Für jedes fehlende OG-Tag wird eine Warnung hinzugefügt.

Folgt dies Weiterleitungen?

Ja. Der Endpunkt folgt bis zu 5 Weiterleitungen und extrahiert Metadaten aus der endgültigen Ziel-URL.

Kann ich Metadaten von Seiten extrahieren, die JavaScript erfordern?

Nein. Der Endpunkt ruft die rohe HTML-Antwort ab. Single-Page-Anwendungen, die OG-Tags über JavaScript einfügen, geben unvollständige Metadaten zurück. Vom Server gerenderte Seiten funktionieren ordnungsgemäß.

Welche häufigen Warnungen werden zurückgegeben?

Zu den Warnungen gehören fehlender og:title, fehlendes og:image, og:description mit mehr als 200 Zeichen, fehlende Twitter-Card-Tags und og:image-URLs, die Nicht-Bild-Inhaltstypen zurückgeben.

Ist die og:image-URL validiert?

Der Endpunkt gibt die og:image-URL unverändert aus dem HTML zurück. Das Bild wird nicht abgerufen, um seine Existenz zu überprüfen oder seine Abmessungen zu überprüfen. Verwenden Sie eine separate HEAD-Anfrage, um die Bild-URL zu validieren.

Get your API key

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