Documentação API Pedra.so

API para criar imágens de staging virtual

Bem-vindo à documentação oficial da API Pedra.so. A nossa API fornece capacidades poderosas de processamento de imágens para várias tarefas de melhoria e design de quartos.

URLs Base

A API pode ser accedida via o seguinte URL base:

  • Production: https://app.pedra.so/api

Autentificação

Todas as chamadas API requerem um parâmetro apiKey para autentificação. Envie um email para felix@pedra.so para solicitar sua chave API.

Parâmetros Comuns

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

  • apiKey (string, required): A sua chave API única para autentificação.
  • imageUrl (string, required): URL da imágen a ser processada.
  • creativity (string, required): Nível de liberdade criativa para a IA.
    • Low: Preserva a arquitetura original com variações mínimas.
    • Medium: Mantém a arquitetura original com variações notáveis mas equilibradas.

Endpoints API

Executar Melhoria

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

Endpoint: /enhance

Method: POST

Parameters: Parâmetros comuns (ver acima)

Expected response time: Entre 25 segundos e 1 minuto

Executar Quarto Vazio

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

Endpoint: /empty_room

Method: POST

Parameters: Parâmetros comuns (ver acima)

Expected response time: Entre 2 e 3 minutos

Executar Mobilar

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

Endpoint: /furnish

Method: POST

Parameters: Parâmetros comuns + roomType + style

Expected response time: Entre 2 e 3 minutos

Possible values for roomType:

  • "Quarto"
  • "Sala de estar"
  • "Cozinha"
  • "Büro"
  • "Terraço"
  • "Sala de jantar"
  • "Cozinha + Sala de estar"
  • "Sala de jantar + Sala de estar"
  • "Entrada"

Possible values for style:

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

Executar Renovação

Renoviert um quarto segundo o estilo especificado.

Endpoint: /renovation

Method: POST

Parameters: Parâmetros comuns + style + preserveWindows

Expected response time: Entre 25 segundos e 2 minutos

Formato de Resposta

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

Tratamento de Erros

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

Suporte

Para quaisquer questões ou problemas sobre a API, por favor contacte a nossa equipa de suporte em <a href="mailto:felix@pedra.so" style="color: rgb(248, 121, 42); text-decoration: none;">felix@pedra.so</a>.