Перейти к содержимому
POST AI agent ready /v1/social-preview/extract

API Social Preview — извлечение метатегов Open Graph и Twitter Card

Получает 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 возвращает нулевые значения для отсутствующих тегов. Общий раздел использует HTML-теги <title> и <meta name="description">. Предупреждение добавляется для каждого отсутствующего тега OG.
Это следует за перенаправлениями?
Да. Конечная точка выполняет до 5 перенаправлений и извлекает метаданные из конечного целевого URL.
Могу ли я извлечь метаданные со страниц, требующих JavaScript?
Нет. Конечная точка получает необработанный HTML-ответ. Одностраничные приложения, которые внедряют теги OG через JavaScript, будут возвращать неполные метаданные. Страницы, отображаемые на сервере, работают правильно.
Какие типичные предупреждения возвращаются?
Предупреждения включают отсутствие og:title, отсутствие og:image, og:description длиной более 200 символов, отсутствие тегов Twitter Card и URL-адреса og:image, которые возвращают типы контента, не являющиеся изображениями.
URL-адрес og:image проверен?
Конечная точка возвращает URL-адрес og:image как есть из HTML. Он не получает изображение для проверки его существования или проверки его размеров. Используйте отдельный запрос HEAD для проверки URL-адреса изображения.

Get your API key

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

Sign up free View full docs