Gere vídeos de anúncios imobiliários a partir de fotos. Adicione legendas, música, características do imóvel e branding personalizado — tudo a partir de uma única chamada JSON síncrona.
POST/api/create_video
Constrói um vídeo MP4 a partir de uma lista de imagens com efeitos de movimento, legendas opcionais, música de fundo, sobreposições com características do imóvel e cartões finais. O endpoint é síncrono: bloqueia até o vídeo ser renderizado e depois devolve HTTP 200 com o videoUrl final.
O endpoint bloqueia até 10 minutos enquanto o vídeo é renderizado, depois devolve o URL reproduzível. Define o timeout do teu cliente HTTP para pelo menos 11 minutos — os 30–60 segundos padrão da maioria das bibliotecas HTTP terminarão antes da Pedra responder.
Se a renderização exceder 10 minutos, o endpoint devolve 500 com {"error": "Video processing timeout after 10 minutes..."}. O vídeo pode ainda terminar em segundo plano — contacta o suporte com o corpo do pedido se isto acontecer.
Parâmetros de topo
apiKeystringobrigatório
A tua chave API.
imagesarrayobrigatório
Lista ordenada de objetos image. Cada um torna-se um frame/clip no vídeo. Ver "Objeto image" abaixo.
isVerticalboolean
Formato vertical 9:16 para Instagram Reels / TikTok. Por defeito 16:9 horizontal.
Default:false
propertyCharacteristicsarray
Array de pares {label, value} (Bedrooms, Bathrooms, Surface, Price, etc). Mostrado apenas quando uma imagem tem characteristics.enabled = true.
musicobject
Música de fundo. Objeto: { enabled: boolean, track: string }.
Logo personalizado, foto do agente e sobreposição de cor de marca. Ver secção "Branding".
endingTitlestring
Título mostrado no cartão final.
endingSubtitlestring
Subtítulo do cartão final (normalmente uma CTA ou informação de contacto).
Objeto image
Cada entrada de images descreve um frame:
imageUrlstringobrigatório
URL da foto (ou data URI base64).
effectstringobrigatório
Efeito de movimento aplicado a este frame.
Values:zoom-inzoom-outstatictransition
secondImageUrlstring
Obrigatório quando effect = "transition". Imagem para a qual transicionar.
subtitlestring
Legenda mostrada sobre este frame.
titlestring
Sobreposição de título grande (ex.: "Living Room", "Kitchen").
watermarkobject
Configuração da marca de água: { enabled, position, opacity }. Ativada por defeito em bottom-right com opacity 1.0. Define { enabled: false } para desativar.
characteristicsobject
Mostra a sobreposição propertyCharacteristics neste frame: { enabled: true }.
Walkthrough de 7 frames com efeitos mistos (zoom-in / zoom-out / transition / static), marca de água personalizada + foto do agente + cor da marca, música, narração, legendas por frame, sobreposição com características do imóvel e cartão final. Corresponde ao padrão de payload real que a própria app Pedra utiliza.
{
"message": "Video created successfully",
"videoId": "<uuid>",
"videoUrl": "https://pedraimages.s3.eu-west-3.amazonaws.com/<uuid>"
}
Créditos
Cada frame custa 5 créditos — exceto frames com effect: "static", que são gratuitos. Um vídeo de 5 imagens com todos os efeitos zoom-in/zoom-out consome 25 créditos. Ver Preços.
Erros de validação
HTTP 400 é devolvido para:
Array images em falta ou vazio.
Qualquer imagem sem imageUrl (o erro indica o índice em falta).
effect fora de [zoom-in, zoom-out, transition, static].
effect: "transition" sem secondImageUrl.
Rótulos de características disponíveis
Ao usar propertyCharacteristics, as seguintes chaves de rótulo são renderizadas com ícones correspondentes na sobreposição: Bedrooms, Bathrooms, Surface, Price, Location, Parking, Heating, Outdoor. Rótulos personalizados são aceites mas renderizados sem ícone.
Seguinte
Ver Erros e limites para os modos de falha das tarefas de vídeo e o comportamento de timeouts.