POST AI agent ready /v1/url-metadata

API метаданных URL – извлечение открытого графика, заголовка и значка

Получает URL-адрес и извлекает заголовок, описание, теги Open Graph, теги Twitter Card, значок значка, канонический URL-адрес, язык, автора, ключевые слова и цвет темы. Полезно для предварительного просмотра ссылок и обмена в социальных сетях.

Endpoint

Code examples

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

When to use this API

Создание расширенного предварительного просмотра ссылок в приложении чата

Когда пользователь вставляет URL-адрес в сообщение чата, вызовите эту конечную точку, чтобы получить заголовок, описание и изображение OG. Отобразите карточку предварительного просмотра под сообщением, аналогично тому, как разворачивается ссылка на отображение в Slack или Discord.

Проверка тегов OG перед публикацией контента

Прежде чем поделиться публикацией в блоге в социальных сетях, извлеките из нее теги OG, чтобы подтвердить правильность заголовка, описания и изображения. Найдите отсутствующие или сокращенные метаданные до того, как они появятся в Twitter, LinkedIn или Facebook.

Создайте менеджер закладок с автоматическими метаданными.

Когда пользователь сохраняет URL-адрес в своей коллекции закладок, заголовок, описание и миниатюра автоматически заполняются из извлеченных метаданных. Избавьте пользователя от ручного ввода данных для каждой закладки.

Frequently asked questions

Поддерживает ли эта конечная точка перенаправления?

Да. Конечная точка следует перенаправлению HTTP и извлекает метаданные из конечного целевого URL-адреса. Поле статуса отражает HTTP-статус окончательного ответа.

В чем разница между полями og и twitter?

og содержит метатеги Open Graph (используются Facebook, LinkedIn и другими). twitter содержит теги Twitter Card. Многие сайты устанавливают оба параметра, но теги Twitter Card имеют приоритет в Twitter/X, если присутствуют оба.

Могу ли я извлечь метаданные из одностраничных приложений?

Конечная точка получает первоначальный ответ HTML без выполнения JavaScript. Если SPA отображает свои метатеги на стороне клиента, эти теги не будут отображаться в ответе.

Есть ли тайм-аут для медленных URL-адресов?

Да. Время ожидания конечной точки истекает через 10 секунд, если целевой URL-адрес не отвечает. Тайм-аут возвращает ошибку 400 с описательным сообщением.

Что содержит каноническое поле?

Поле canonical содержит значение тега <link rel="canonical">, которое указывает предпочтительный URL-адрес страницы. Это поможет вам дедуплицировать URL-адреса, которые обслуживают один и тот же контент.

Get your API key

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