Pular para o conteúdo
POST AI agent ready /v1/social-preview/extract

API de visualização social - Extraia metatags de gráfico aberto e cartão do Twitter

Busca uma URL e extrai tags Open Graph (og:title, og:description, og:image, og:type, og:site_name), tags Twitter Card (twitter:card, twitter:title, twitter:image, twitter:site, twitter:creator) e metadados HTML gerais (título, descrição, canônico, favicon). Retorna avisos para tags ausentes ou malformadas.

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

Vincule cartões de visualização em plataformas de chat e CMS

Quando um usuário cola um URL em seu aplicativo, chame esse endpoint para buscar os dados do Open Graph e renderizar um cartão de visualização de link avançado com título, descrição e imagem. Funciona para desdobramento de link no estilo Slack.

Auditoria de SEO para compartilhamento social

Digitalize suas páginas para verificar se as tags Open Graph e Twitter Card estão presentes e formatadas corretamente. Identifique tags og:image ausentes ou descrições truncadas antes de compartilhar campanhas.

Enriquecimento do sistema de gerenciamento de conteúdo

Quando os editores adicionam links externos aos artigos, preencha automaticamente o título, a descrição e a miniatura do link a partir dos metadados extraídos. Economiza a entrada manual de dados e mantém a consistência dos cartões de visualização.

Frequently asked questions

O que acontece se a página não tiver tags Open Graph?
A seção og retorna valores nulos para tags ausentes. A seção geral recorre às tags HTML <title> e <meta name="description">. Um aviso é adicionado para cada tag OG ausente.
Isso segue redirecionamentos?
Sim. O endpoint segue até cinco redirecionamentos e extrai metadados do URL de destino final.
Posso extrair metadados de páginas que requerem JavaScript?
Não. O endpoint busca a resposta HTML bruta. Aplicativos de página única que injetam tags OG via JavaScript retornarão metadados incompletos. As páginas renderizadas pelo servidor funcionam corretamente.
Quais são os avisos comuns retornados?
Os avisos incluem og:title ausente, og:image ausente, og:description com mais de 200 caracteres, tags de cartão do Twitter ausentes e URLs og:image que retornam tipos de conteúdo que não são de imagem.
O URL og:image foi validado?
O endpoint retorna o URL og:image como está no HTML. Ele não busca a imagem para verificar se ela existe ou verifica suas dimensões. Use uma solicitação HEAD separada para validar o URL da imagem.

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