Produto
Preços

Documentação da API Pedra.so

API para criar imagens de home staging virtual

Bem-vindo à documentação oficial da API Pedra.so. Nossa API fornece recursos poderosos de processamento de imagem para várias tarefas de aprimoramento e design de ambientes.


URLs Base

A API pode ser acessada através da seguinte URL base:

  • Produção: https://app.pedra.so/api

Autenticação

Todas as chamadas da API requerem um parâmetro apiKey para autenticação. Envie um e-mail para felix@pedra.so para solicitar sua chave de API.


Parâmetros Comuns

Os seguintes parâmetros são comuns a todos os endpoints:

  • apiKey (string, obrigatório): Sua chave de API única para autenticação.
  • imageUrl (string, obrigatório): URL da imagem a ser processada.
  • creativity (string, obrigatório): Nível de liberdade criativa para a IA.
    • Baixa: Preserva a arquitetura original com poucas variações.
    • Média: Mantém a arquitetura original com variações equilibradas.

Endpoints

Executar Aprimoramento

Aprimora a qualidade, cor, luz e resolução da imagem fornecida.

Endpoint: /enhance

Método: POST

Parâmetros: Parâmetros comuns (ver acima)

Tempo de resposta esperado: Entre 25 segundos e 1 minuto


Executar Ambiente Vazio

Remove móveis e objetos do ambiente na imagem fornecida.

Endpoint: /empty_room

Método: POST

Parâmetros: Parâmetros comuns (ver acima)

Tempo de resposta esperado: Entre 2 e 3 minutos


Executar Mobiliamento

Mobilia (cria um home staging virtual) de um espaço de acordo com os parâmetros especificados.

Endpoint: /furnish

Método: POST

Parâmetros:

  • Parâmetros comuns (ver acima)
  • roomType (string, obrigatório): Tipo de ambiente a ser mobiliado.
  • style (string, obrigatório): Estilo de design a ser aplicado.

Tempo de resposta esperado: Entre 2 e 3 minutos

Valores possíveis para roomType:

  • "Quarto"
  • "Sala de estar"
  • "Cozinha"
  • "Escritório"
  • "Terraço"
  • "Sala de jantar"
  • "Cozinha + Sala de estar"
  • "Sala de jantar + Sala de estar"
  • "Entrada"

Valores possíveis para style:

  • "Tradicional"
  • "Minimalista"
  • "Escandinavo"
  • "Meio do século"
  • "Boêmio"
  • "Industrial"
  • "Mediterrâneo"
  • "Moderno"
  • "Pirineus"

Executar Renovação

Renova um ambiente de acordo com o estilo especificado.

Endpoint: /renovation

Método: POST

Parâmetros:

  • Parâmetros comuns (ver acima)
  • style (string, obrigatório): Estilo de design a ser aplicado para renovação.
  • preserveWindows (boolean, obrigatório): Se deve preservar as janelas existentes durante a renovação.

Tempo de resposta esperado: Entre 25 segundos e 2 minutos


Formato de Resposta

Todos os endpoints da API retornam respostas em JSON. Uma resposta bem-sucedida terá um código de status 200 e incluirá as informações da imagem processada.


Tratamento de Erros

Em caso de erro, a API retornará um código de status HTTP apropriado junto com uma resposta JSON contendo detalhes do erro.


Suporte

Para quaisquer dúvidas ou problemas relacionados à API, entre em contato com nossa equipe de suporte em felix@pedra.so.