Referência da API de imagens OG

A referência da API de imagens OG abrange o endpoint, os parâmetros e o catálogo de templates para gerar imagens dinâmicas do Open Graph com o FastOG. A API é restrita a assinatura — é necessário um plano Dynamic API ativo, mas as renderizações em si não são medidas: não há cota mensal de renderizações nem cobrança por excedente. URLs assinadas com HMAC mantêm cada requisição segura. Cadastre-se, escolha um plano Dynamic API e então crie sua chave de API e seu segredo HMAC no dashboard; as renderizações pagas da API são limpas. O contrato OpenAPI gerado é a lista autoritativa legível por máquina de parâmetros, códigos de erro e slugs de templates.

URL base

https://fastog.com/api/v1/og

Autenticação

Todas as requisições exigem autenticação por assinatura HMAC-SHA256. A key pública e a assinatura s são parâmetros de query; a autenticação baseada em header não é suportada no momento. Consulte a Documentação de HMAC para mais detalhes.

Endpoint

GET /api/v1/og

Gera uma imagem Open Graph dinâmica com base nos parâmetros fornecidos.

Parâmetros de consulta

Parâmetros específicos de template

Cada template aceita os parâmetros compartilhados abaixo mais seus parâmetros específicos de template (consulte a tabela de índice). O parâmetro de consulta template seleciona qual layout é usado (padrão: default).

Parâmetros compartilhados (todos os templates)

Índice de templates — 67 slugs renderizáveis, 48 selecionáveis. A tabela abaixo documenta os visuais mais usados e suas props específicas de template; a lista exaustiva e gerada (label, categoria, flag de descontinuado e todos os slugs aceitos) está em /openapi.json em x-template-catalogue, e os campos de editor de cada template (key, label, type, default, options e formato de URL) estão em x-template-fields. Slugs descontinuados continuam renderizáveis para que URLs já em uso continuem funcionando, mas eles não são oferecidos pelos seletores.

glassproduct também aceita cta. Os templates ecommerce, product, glassproduct e imageright exibem "Shop now" por padrão; defina cta com um valor vazio para ocultar a pílula visual.

Tipos de parâmetros estruturados

Resposta

• 200 OK — Retorna dados de imagem PNG
• 401 Unauthorized — Autenticação inválida ou ausente
• 422 Unprocessable — Parâmetros de template inválidos

Respostas de erro

Exemplo de requisição

GET /api/v1/og?template=blog&title=Hello%20World&subtitle=A%20test%20post&key=sk_quick_123abc&s=a1b2c3...

Exemplo de cURL

curl "https://fastog.com/api/v1/og?template=blog&title=Hello%20World&key=sk_quick_123abc&s=<signature>"

Preços e limites

O FastOG é condicionado à assinatura: é necessário um plano Dynamic API ativo. As renderizações não são medidas — não há cota mensal de renderizações nem cobrança por excedente. O plano é o requisito, e todos os níveis renderizam sem contador. Consulte Preços para os níveis e preços atuais.

Imagens em cache são gratuitas: as requisições atendidas pelo cache de borda da Cloudflare (mesmo template + parâmetros, independentemente da assinatura s em uma URL previamente armazenada em cache) nunca chegam à origem, então uma URL idêntica não consome outra renderização.

Limpo por padrão: toda renderização é limpa — sem marca d'água em nenhum plano, e nenhuma no OG Image Tester gratuito, nas prévias do Studio ou nas exportações do Studio. Uma prop de renderização fastog_watermark ainda é suportada para chamadores que solicitam explicitamente um selo "Made with FastOG", mas nada a define automaticamente.

Relacionados

• Documentação — Todos os guias e referências do FastOG
• Testador de imagem OG gratuito — Visualize sem uma conta
• Guia de início rápido — inclui o fluxo de arquitetura (assinatura no momento da renderização)
• Guia de assinatura HMAC
• Validação HMAC
• Tutorial de JavaScript