Documentação API pedra.ai

Executar Melhoria

Améliore a qualidade, cor, luz e resolução da imágen fornecida.

Endpoint: /enhance

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string"
}

Expected response time: 25 segundos

Executar Quarto Vazio

Remove móveis e desordem do quarto na imágen fornecida.

Endpoint: /empty_room

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string"
}

Expected response time: 25 segundos

Executar Mobilar

Mobila (cria staging virtual) de um espaço segundo parâmetros especificados.

Endpoint: /furnish

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string",
  "roomType": "string",
  "style": "string",
  "creativity": "Medium" | "High"
}

Expected response time: 25 segundos

roomType (string):

You can write any room type (e.g., "Living room", "Bedroom", "Kitchen", "Office", etc.)

Example values for style:

• "Tradicionel"
• "Minimalista"
• "Escandinave"
• "Mid-Century"
• "Bohème"
• "Industrial"
• "Mediterrâneo"
• "Moderno"
• "Pirenéus"

Executar Renovação

Renova um quarto de acordo com o estilo especificado.

Endpoint: /renovation

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string",
  "creativity": "Medium" | "High",
  "furnish": true | false,
  "style": "string",
  "roomType": "string"
}

Expected response time: 25 segundos

roomType and style:

Same options as the Furnish endpoint above.

Céu Azul

Melhora o céu em imagens exteriores, fazendo-o aparecer azul e vibrante.

Endpoint: /sky_blue

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string"
}

Expected response time: ~15 segundos

Editar com Prompt

Edita a imagem com base numa instrução em linguagem natural que descreve as alterações desejadas.

Endpoint: /edit_via_prompt

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string",
  "prompt": "string"
}

Expected response time: ~20 segundos

Remover Objeto

Remove objetos da imagem usando uma máscara para especificar quais áreas remover.

Endpoint: /remove_object

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string",
  "maskUrl": "string"
}

Expected response time: ~15 segundos

Desfocar Objetos

Desfoca objetos específicos na imagem com base na lista de objetos a desfocar fornecida.

Endpoint: /blur

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string",
  "objectsToBlur": "string"
}

O parâmetro objectsToBlur deve ser uma lista de objetos separados por vírgulas (por exemplo, "placa do carro, rosto").

Expected response time: ~20 segundos

Criar Vídeo

Cria um vídeo imobiliário profissional combinando várias imagens com efeitos, sobreposições, música e branding. Os vídeos são criados de forma assíncrona.

Endpoint: /create_video

Method: POST

Parameters

{
  "apiKey": "string",
  "images": [
    {
      "imageUrl": "string",
      "effect": "zoom-in" | "zoom-out",
      "subtitle": "string",
      "title": "string",
      "watermark": {
        "enabled": true | false,
        "position": "top-left" | "top" | "top-right" | "left" | "center" |
                    "right" | "bottom-left" | "bottom" | "bottom-right",
        "opacity": 0.0-1.0
      },
      "characteristics": {
        "enabled": true | false
      }
    }
  ],
  "isVertical": true | false,
  "propertyCharacteristics": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "music": {
    "enabled": true | false,
    "track": "calm" | "uplifting" | "corporate" | "piano"
  },
  "voice": {
    "enabled": true | false,
    "audioUrl": "string"
  },
  "branding": {
    "showWatermark": true | false,
    "watermarkUrl": "string",
    "showProfessionalPicture": true | false,
    "professionalPictureUrl": "string",
    "primaryColor": "string"
  },
  "endingTitle": "string",
  "endingSubtitle": "string"
}

Expected response time

2-5 minutos

Sobreposição de Características da Propriedade

Adicione detalhes da propriedade como uma pílula sobreposta na parte inferior dos quadros de vídeo. Características são detalhes da propriedade (como quartos, banheiros, área, preço) que aparecem nos quadros onde estão habilitados.

Como Funciona

• Defina características no nível raiz usando o array propertyCharacteristics
• Habilite por quadro definindo characteristics: {enabled: true} em imagens específicas
• Até 4 características são exibidas por quadro com ícones e valores
• Use etiquetas padrão (Bedrooms, Bathrooms, Surface, Price, etc.) para exibição correta do ícone

Etiquetas de Características Disponíveis

Essas etiquetas são reconhecidas e exibidas com ícones apropriados:

• Bedrooms - Ícone de cama (ex. "3", "4 quartos")
• Bathrooms - Ícone de banheiro (ex. "2", "2,5 banh")
• Surface - Ícone de expansão (ex. "120m²", "1.500 m²")
• Price - Ícone de dólar (ex. "$450k", "€320.000")
• Location - Ícone de pin (ex. "Centro", "Malibu")
• Parking - Ícone de carro (ex. "2 carros", "Garagem")
• Heating - Ícone de fogo (ex. "Central", "Gás")
• Outdoor - Ícone de árvore (ex. "Jardim", "Piscina")

Exemplo de Solicitação

Aqui está um exemplo completo criando um vídeo vertical com sobreposição de características da propriedade:

{
  "apiKey": "your-api-key",
  "images": [
    {
      "imageUrl": "https://example.com/image1.jpg",
      "effect": "zoom-in",
      "subtitle": "🏡 Stunning Family Home",
      "watermark": {"enabled": false},
      "characteristics": {"enabled": true}
    },
    {
      "imageUrl": "https://example.com/image2.jpg",
      "effect": "zoom-out",
      "subtitle": "Modern Kitchen & Living",
      "watermark": {"enabled": false},
      "characteristics": {"enabled": true}
    }
  ],
  "propertyCharacteristics": [
    {"label": "Bedrooms", "value": "3"},
    {"label": "Bathrooms", "value": "2"},
    {"label": "Surface", "value": "120m²"},
    {"label": "Price", "value": "$450,000"}
  ],
  "isVertical": true,
  "music": {
    "enabled": true,
    "track": "uplifting"
  },
  "endingTitle": "Schedule a Viewing!",
  "endingSubtitle": "Swipe up or DM us"
}