Ideal House
Pular para o conteúdo

Documentação da Home Decor API#

URL Base: https://api.ideal.house
Versão: v1
Atualizado: 2026-05-21


📖 Visão Geral#

A Home Decor API gera ideias de decoração para uma imagem de ambiente interno. Ela suporta orientação textual opcional, imagem de referência, seleções de estilo e modos de modelo.

O fluxo de trabalho é assíncrono:

  1. Criar uma tarefa — Envie imageUrl e parâmetros opcionais, depois receba um taskId.
  2. Consultar resultados — Use taskId para recuperar o status da tarefa e a imagem gerada.

🔐 Autenticação#

CabeçalhoValor
APIKEYyour_api_key_here

💰 Dedução de Créditos#

[!WARNING] Os créditos são deduzidos quando uma tarefa é criada com sucesso. Se a tarefa finalmente falhar, os créditos deduzidos serão estornados automaticamente.
Créditos insuficientes retornarão o código de erro 9051. Consulte a Referência de Dedução de Créditos.

Modelo (modelType)Créditos Deduzidos
Base3 créditos
Pro10 créditos

Se modelType não for fornecido, Base é usado por padrão.


🎨 Opções de Estilo#

Esta API suporta parâmetros de estilo opcionais retornados pelo endpoint Configuração de Estilo da API.

Uso:

Texto simples
GET /api/v1/style/home_decor_ideas/getStyles
Grupo de EstiloCampo na RequisiçãoDescrição
spaceTypespaceStyleIdOpção de espaço ou tipo de ambiente
decorStylehomeDecorStyleIdOpção de estilo de decoração

Cada opção contém name, id e url. Passe o id da opção no campo correspondente da requisição.


📌 Endpoints da API#

1. Criar Tarefa de Home Decor#

Endpointo

Texto simples
POST /api/v1/homeDecor/generate

Cabeçalhos da Requisição

CabeçalhoObrigatórioDescrição
APIKEY✅ SimSua chave de autenticação API
Content-Type✅ Simapplication/json

Corpo da Requisição

CampoTipoObrigatórioDescrição
imageUrlstring✅ SimURL da imagem interna fonte
referenceUrlstring❌ OpcionalURL da imagem de referência para orientar o estilo de decoração
spaceStyleIdstring❌ OpcionalID do tipo de espaço das opções de estilo spaceType
homeDecorStyleIdstring❌ OpcionalID do estilo de decoração das opções de estilo decorStyle
promptstring❌ OpcionalOrientação textual para o resultado desejado
modelTypestring❌ OpcionalEnum: Base, Pro. Padrão: Base

Somente imageUrl é obrigatório. Todos os outros campos são opcionais.

🖼️ Requisitos de imagem: Todas as imagens fonte e de referência devem usar JPG/JPEG, PNG ou WebP. Cada imagem deve ter no máximo 20 MB, com dimensões de 128 × 128 px até 6,000 × 6,000 px (inclusivo). Imagens que excedam as dimensões máximas em pixels são automaticamente reduzidas proporcionalmente para caber dentro de 6,000 × 6,000 px antes do processamento. As URLs das imagens devem ser diretamente acessíveis pelo servidor da API.

📥 Exemplos de Requisição#

cURL
bash
curl -X POST "https://api.ideal.house/api/v1/homeDecor/generate" \
  -H "APIKEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "imageUrl": "https://example.com/room.jpg",
    "referenceUrl": "https://example.com/reference.jpg",
    "spaceStyleId": "Indoor_Living Room",
    "homeDecorStyleId": "Holidays_Cozy Christmas",
    "prompt": "warm seasonal decor with natural textures",
    "modelType": "Base"
  }'
Java (OkHttp)
java
import okhttp3.*;

import java.io.IOException;

public class HomeDecorApiExample {

    private static final String BASE_URL = "https://api.ideal.house";
    private static final String API_KEY = "your_api_key_here";

    public static void main(String[] args) throws IOException {
        OkHttpClient client = new OkHttpClient();

        String requestBody = """
                {
                    "imageUrl": "https://example.com/room.jpg",
                    "referenceUrl": "https://example.com/reference.jpg",
                    "spaceStyleId": "Indoor_Living Room",
                    "homeDecorStyleId": "Holidays_Cozy Christmas",
                    "prompt": "warm seasonal decor with natural textures",
                    "modelType": "Base"
                }
                """;

        Request request = new Request.Builder()
                .url(BASE_URL + "/api/v1/homeDecor/generate")
                .addHeader("APIKEY", API_KEY)
                .addHeader("Content-Type", "application/json")
                .post(RequestBody.create(requestBody, MediaType.parse("application/json")))
                .build();

        try (Response response = client.newCall(request).execute()) {
            System.out.println("Response: " + response.body().string());
        }
    }
}
Python (requests)
python
import requests

BASE_URL = "https://api.ideal.house"
API_KEY = "your_api_key_here"

headers = {
    "APIKEY": API_KEY,
    "Content-Type": "application/json"
}

payload = {
    "imageUrl": "https://example.com/room.jpg",
    "referenceUrl": "https://example.com/reference.jpg",
    "spaceStyleId": "Indoor_Living Room",
    "homeDecorStyleId": "Holidays_Cozy Christmas",
    "prompt": "warm seasonal decor with natural textures",
    "modelType": "Base"
}

response = requests.post(
    f"{BASE_URL}/api/v1/homeDecor/generate",
    headers=headers,
    json=payload
)

data = response.json()
task_id = data.get("data")
print(f"Task ID: {task_id}")
Node.js (axios)
javascript
const axios = require('axios');

const BASE_URL = 'https://api.ideal.house';
const API_KEY = 'your_api_key_here';

async function createHomeDecorTask() {
  try {
    const response = await axios.post(
      `${BASE_URL}/api/v1/homeDecor/generate`,
      {
        imageUrl: 'https://example.com/room.jpg',
        referenceUrl: 'https://example.com/reference.jpg',
        spaceStyleId: 'Indoor_Living Room',
        homeDecorStyleId: 'Holidays_Cozy Christmas',
        prompt: 'warm seasonal decor with natural textures',
        modelType: 'Base'
      },
      {
        headers: {
          APIKEY: API_KEY,
          'Content-Type': 'application/json'
        }
      }
    );

    const taskId = response.data.data;
    console.log('Task ID:', taskId);
    return taskId;
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
}

createHomeDecorTask();

📤 Resposta#

json
{
  "code": 0,
  "message": "success",
  "data": 1234567890123456789
}

2. Obter Resultado da Tarefa#

Endpointo

Texto simples
GET /api/v1/homeDecor/result

Cabeçalhos da Requisição

CabeçalhoObrigatórioDescrição
APIKEY✅ SimSua chave de autenticação API

Parâmetros de Consulta

ParâmetroTipoObrigatórioDescrição
taskIdlong✅ SimID da tarefa retornado pelo endpoint de criação

📥 Exemplos de Requisição#

cURL
bash
curl -X GET "https://api.ideal.house/api/v1/homeDecor/result?taskId=1234567890123456789" \
  -H "APIKEY: your_api_key_here"
Java (OkHttp)
java
import okhttp3.*;

import java.io.IOException;

public class HomeDecorResultExample {

    private static final String BASE_URL = "https://api.ideal.house";
    private static final String API_KEY = "your_api_key_here";

    public static void main(String[] args) throws IOException {
        OkHttpClient client = new OkHttpClient();
        long taskId = 1234567890123456789L;

        Request request = new Request.Builder()
                .url(BASE_URL + "/api/v1/homeDecor/result?taskId=" + taskId)
                .addHeader("APIKEY", API_KEY)
                .get()
                .build();

        try (Response response = client.newCall(request).execute()) {
            System.out.println("Response: " + response.body().string());
        }
    }
}
Python (requests)
python
import requests
import time

BASE_URL = "https://api.ideal.house"
API_KEY = "your_api_key_here"

headers = {"APIKEY": API_KEY}
task_id = 1234567890123456789

while True:
    response = requests.get(
        f"{BASE_URL}/api/v1/homeDecor/result",
        headers=headers,
        params={"taskId": task_id}
    )

    data = response.json()
    result = data.get("data", {})
    status = result.get("status")

    print(f"Status: {status}, Progress: {result.get('percentage')}%, Queue: {result.get('waitNumber')}")

    if status in ("Success", "Failed"):
        break

    time.sleep(3)

if status == "Success":
    print("Result URL:", result["output"]["resultUrl"])
else:
    print("Task ended with status:", status)
Node.js (axios)
javascript
const axios = require('axios');

const BASE_URL = 'https://api.ideal.house';
const API_KEY = 'your_api_key_here';

async function pollHomeDecorResult(taskId) {
  const headers = { APIKEY: API_KEY };

  while (true) {
    const response = await axios.get(
      `${BASE_URL}/api/v1/homeDecor/result`,
      {
        headers,
        params: { taskId }
      }
    );

    const result = response.data.data;
    const { status, percentage, waitNumber } = result;
    console.log(`Status: ${status} | Progress: ${percentage}% | Queue: ${waitNumber}`);

    if (['Success', 'Failed'].includes(status)) {
      if (status === 'Success') {
        console.log('Result URL:', result.output.resultUrl);
        console.log('Size:', result.output.width, 'x', result.output.height);
      } else {
        console.log('Task ended with status:', status);
      }
      break;
    }

    await new Promise(resolve => setTimeout(resolve, 3000));
  }
}

pollHomeDecorResult(1234567890123456789n);

📤 Exemplo de Resposta#

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Success",
    "waitNumber": 0,
    "percentage": 100,
    "input": {
      "imageUrl": "https://example.com/room.jpg",
      "refImageUrl": "https://example.com/reference.jpg",
      "spaceStyleId": "Indoor_Living Room",
      "homeDecorStyleId": "Holidays_Cozy Christmas",
      "prompt": "warm seasonal decor with natural textures",
      "modelType": "Base"
    },
    "output": {
      "resultUrl": "https://cdn.ideal.house/output/home_decor_result.jpg",
      "width": 1024,
      "height": 1024
    }
  }
}

Resposta (Tarefa em Processamento / Em Fila)

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Processing",
    "waitNumber": 1,
    "percentage": 45,
    "input": {
      "imageUrl": "https://example.com/room.jpg",
      "modelType": "Base"
    },
    "output": null
  }
}

Resposta (Tarefa Falhou)

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Failed",
    "waitNumber": 0,
    "percentage": 0,
    "input": {
      "imageUrl": "https://example.com/room.jpg",
      "modelType": "Base"
    },
    "output": null
  }
}

📊 Status da Tarefa#

StatusDescrição
UnprocessedTarefa foi criada e está aguardando na fila
ProcessingTarefa está sendo executada atualmente
SuccessTarefa concluída com sucesso
FailedTarefa falhou e nenhuma saída foi produzida

Consulte a cada 3-5 segundos. Consulte a Limitação de Tarefas da API.


❌ Respostas de Erro#

CódigoNomeDescrição
1011PARAM_ERRORErro nos parâmetros da requisição
5002API_KEY_INVALIDChave API inválida ou ausente
9010SCAN_TEXT_ERRORFalha na revisão de conteúdo do prompt
9038PROHIBITED_CONTENTA imagem gerada contém conteúdo proibido
9051COINS_NOT_ENOUGHCréditos insuficientes

Para definições completas de erros comuns, consulte a Referência de Códigos de Erro.