Pular para o conteúdo principal

​
Endpoint

POST https://api.bunny.build/api/v1/social-metadata

​
Autenticação

HeaderObrigatórioValor
X-API-KeySimSua chave de API (bun_...)
Content-TypeSimapplication/json

​
Visão geral

Busque e analise tags Open Graph, metadados Twitter Card e meta tags HTML padrão de qualquer URL pública. Retorna um objeto estruturado com título, descrição, imagem e propriedades de compartilhamento social, pronto para usar em componentes de pré-visualização de links, pipelines de ingestão de conteúdo ou ferramentas de auditoria de SEO.

​
Casos de uso

  • Renderizar pré-visualizações ricas de links em aplicativos de chat ou feeds sociais
  • Auditar a completude do Open Graph em suas próprias páginas
  • Ingerir metadados de artigos externos para ferramentas de curadoria de conteúdo
  • Preencher pré-visualizações de compartilhamento quando usuários colam links

​
Detalhes

A API busca a URL de destino no servidor e analisa as meta tags HTML. Páginas renderizadas por JavaScript podem retornar metadados incompletos. Redirecionamentos são seguidos automaticamente. URLs privadas ou protegidas por autenticação retornarão dados vazios ou parciais.

​
Corpo da requisição

CampoTipoObrigatórioDescrição
urlstringSimURL pública para extrair os metadados

​
Exemplo

{
  "url": "https://bunny.build"
}

​
Resposta

​
200 OK

CampoTipoDescrição
urlstringURL resolvida (após redirecionamentos)
titlestringTítulo da página (OG ou <title>)
descriptionstringDescrição da página
imagestringURL da imagem OG ou Twitter
site_namestringValor de og:site_name
typestringValor de og:type (ex.: website, article)
Exemplo 
{
  "url": "https://bunny.build",
  "title": "Bunny — APIs for developers",
  "description": "Build faster with Bunny's ready-to-use API toolkit.",
  "image": "https://bunny.build/og.png",
  "site_name": "Bunny",
  "type": "website"
}

​
401 Unauthorized

{
  "detail": "Missing API key. Include X-API-Key header."
}

​
402 Payment Required

{
  "detail": "Monthly quota exceeded. Upgrade your plan."
}

​
422 Unprocessable Entity

{
  "detail": "Invalid or unreachable URL"
}

​
429 Too Many Requests

{
  "detail": "Rate limit exceeded. Try again in 60 seconds."
}

​
Exemplo cURL

curl -X POST https://api.bunny.build/api/v1/social-metadata \
  -H "X-API-Key: bun_sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://bunny.build"}'