Documentação API pedra.ai

API para criar imágens de staging virtual

Bem-vindo à documentação oficial da API pedra.ai. 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.ai/api

Autentificação

Todas as chamadas API requerem um parâmetro apiKey para autentificação. Envie um email para felix@pedra.ai 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 imagem (http/https) ou URI de dados base64 (data:image/...).

Endpoints API

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

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 felix@pedra.ai.