Propriedades

API de propriedades

Explora as propriedades de uma conta Pedra, lê os URLs das suas fotos para usar no create_video e nos endpoints de edição, cria propriedades e adiciona-lhes fotos por URL.

Os propriétéos são a forma como as fotos são organizadas numa conta Pedra. Estes endpoints permitem explorar os propriétéos de um utilizador, ler os URLs das fotos de um propriétéo (para os passar diretamente ao create_video ou aos endpoints de edição), criar propriétéos e adicionar-lhes fotos por URL — o servidor descarrega cada URL e armazena-a, por isso funciona qualquer imagem pública.

As fotos que já estão na conta são a fonte mais fácil para um vídeo. Para adicionar ficheiros locais novos (que não podem ser enviados pela API), abre o propriétéo na Pedra através do appUrl que estes endpoints devolvem e carrega-os lá.

Listar propriétéos

POST/api/list_properties

Devolve os propriétéos da conta (mais recentes primeiro), cada um com uma contagem de fotos e um appUrl.

apiKeystringobrigatório
A tua chave API.
curl -X POST https://app.pedra.ai/api/list_properties \
  -H "Content-Type: application/json" \
  -d '{ "apiKey": "YOUR_API_KEY" }'

Resposta

JSON
{
  "properties": [
    {
      "propertyId": "<uuid>",
      "name": "Calle Mayor 12",
      "createdAt": "2026-06-30T10:00:00.000Z",
      "photoCount": 8,
      "appUrl": "https://app.pedra.ai/?propertyId=<uuid>"
    }
  ]
}

Listar fotos do propriétéo

POST/api/list_property_images

Devolve as fotos de um propriétéo como URLs públicos img.pedra.ai — passa-as diretamente ao create_video ou aos endpoints de edição de imagens.

apiKeystringobrigatório
A tua chave API.
propertyIdstringobrigatório
O id do propriétéo (de list_properties ou create_property).
curl -X POST https://app.pedra.ai/api/list_property_images \
  -H "Content-Type: application/json" \
  -d '{ "apiKey": "YOUR_API_KEY", "propertyId": "PROPERTY_ID" }'

Resposta

JSON
{
  "propertyId": "<uuid>",
  "name": "Calle Mayor 12",
  "images": [
    {
      "imageId": "<uuid>",
      "url": "https://img.pedra.ai/<uuid>",
      "name": "Image 1",
      "aspectRatio": 1.5
    }
  ]
}

Criar um propriétéo

POST/api/create_property

Cria um propriétéo vazio e devolve o seu propertyId e appUrl.

apiKeystringobrigatório
A tua chave API.
namestring
Nome do propriétéo, p. ex. a morada do anúncio. Opcional.
curl -X POST https://app.pedra.ai/api/create_property \
  -H "Content-Type: application/json" \
  -d '{ "apiKey": "YOUR_API_KEY", "name": "Calle Mayor 12" }'

Resposta

JSON
{
  "message": "Property created",
  "propertyId": "<uuid>",
  "appUrl": "https://app.pedra.ai/?propertyId=<uuid>"
}

Adicionar fotos a um propriétéo

POST/api/add_images_to_property

Adiciona fotos a um propriétéo por URL. O servidor descarrega cada URL e armazena-a (por isso funciona qualquer imagem https pública — ou um pequeno URI data:), e depois devolve os URLs img.pedra.ai armazenados. Até 20 por chamada.

apiKeystringobrigatório
A tua chave API.
propertyIdstringobrigatório
O id do propriétéo (de list_properties ou create_property).
imageUrlsarrayobrigatório
Array de URLs de imagem para descarregar e adicionar (máx. 20). Também é aceite uma única string imageUrl.
curl -X POST https://app.pedra.ai/api/add_images_to_property \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "YOUR_API_KEY",
    "propertyId": "PROPERTY_ID",
    "imageUrls": [
      "https://example.com/kitchen.jpg",
      "https://example.com/living-room.jpg"
    ]
  }'

Resposta

JSON
{
  "message": "Added 2 image(s)",
  "propertyId": "<uuid>",
  "added": [
    { "imageId": "<uuid>", "url": "https://img.pedra.ai/<uuid>", "aspectRatio": 1.5 }
  ],
  "failed": [],
  "appUrl": "https://app.pedra.ai/?propertyId=<uuid>"
}

Seguinte

Passa os URLs das fotos de um propriétéo ao create_video, ou usa-os com qualquer endpoint de home staging virtual / melhoria.