Ideal House
콘텐츠로 이동

홈 데코 API 문서#

기본 URL: https://api.ideal.house
버전: v1
갱신일: 2026-05-21


📖 개요#

홈 데코 API는 실내 이미지에 대한 장식 아이디어를 생성합니다. 선택적 텍스트 지침, 참조 이미지, 스타일 선택 및 모델 모드를 지원합니다.

작업 흐름은 비동기 방식입니다.

  1. 작업 생성imageUrl과 선택 매개변수를 제출하고 taskId를 받습니다.
  2. 결과 폴링taskId로 작업 상태와 생성된 이미지를 조회합니다.

🔐 인증#

헤더
APIKEYyour_api_key_here

💰 크레딧 차감#

[!WARNING] 크레딧은 작업이 성공적으로 생성될 때 차감됩니다. 작업이 최종적으로 실패하면 차감된 크레딧은 자동 환불됩니다.
크레딧이 부족하면 오류 코드 9051을 반환합니다. 크레딧 차감 참조를 참고하세요.

모델 (modelType)차감 크레딧
Base3크레딧
Pro10크레딧

modelType을 제공하지 않으면 기본값으로 Base를 사용합니다.


🎨 스타일 옵션#

이 API는 API 스타일 설정 엔드포인트가 반환하는 선택적 스타일 매개변수를 지원합니다.

사용 항목:

일반 텍스트
GET /api/v1/style/home_decor_ideas/getStyles
스타일 그룹요청 필드설명
spaceTypespaceStyleId공간 또는 방 유형 옵션
decorStylehomeDecorStyleId장식 스타일 옵션

각 옵션에는 name, idurl이 포함됩니다. 옵션의 id를 해당 요청 필드에 전달하세요.


📌 API 엔드포인트#

1. 홈 데코 작업 생성#

엔드포인트

일반 텍스트
POST /api/v1/homeDecor/generate

요청 헤더

헤더필수 여부설명
APIKEY✅ 예API 인증 키
Content-Type✅ 예application/json

요청 본문

필드유형필수 여부설명
imageUrlstring✅ 예원본 실내 이미지 URL
referenceUrlstring❌ 선택장식 스타일을 유도하는 참조 이미지 URL
spaceStyleIdstring❌ 선택spaceType 스타일 옵션의 공간 유형 ID
homeDecorStyleIdstring❌ 선택decorStyle 스타일 옵션의 장식 스타일 ID
promptstring❌ 선택원하는 결과에 대한 텍스트 지침
modelTypestring❌ 선택열거형: Base, Pro. 기본값 Base

imageUrl만 필수입니다. 나머지 필드는 모두 선택 사항입니다.

🖼️ 이미지 요건: 모든 원본 및 참조 이미지는 JPG/JPEG, PNG 또는 WebP여야 합니다. 각 이미지는 20 MB 이하여야 하며 크기는 128 × 128 px부터 6,000 × 6,000 px까지 허용됩니다(경계값 포함). 최대 픽셀 크기를 초과하는 이미지는 처리 전에 6,000 × 6,000 px 안에 들어오도록 비율을 유지하여 자동 축소됩니다. 이미지 URLs는 API 서버에서 직접 접근할 수 있어야 합니다.

📥 요청 예제#

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();

📤 응답#

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

2. 작업 결과 조회#

엔드포인트

일반 텍스트
GET /api/v1/homeDecor/result

요청 헤더

헤더필수 여부설명
APIKEY✅ 예API 인증 키

쿼리 매개변수

매개변수유형필수 여부설명
taskIdlong✅ 예생성 엔드포인트가 반환한 작업 ID

📥 요청 예제#

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);

📤 응답 예제#

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
    }
  }
}

응답 (작업 처리 중 / 대기열에 있음)

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
  }
}

응답 (작업 실패)

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
  }
}

📊 작업 상태#

상태설명
Unprocessed작업이 생성되어 대기열에서 기다리는 중
Processing작업이 현재 실행 중
Success작업이 성공적으로 완료됨
Failed작업이 실패하여 출력이 생성되지 않음

3-5초마다 폴링하세요. API 작업 제한을 참고하세요.


❌ 오류 응답#

코드이름설명
1011PARAM_ERROR요청 매개변수 오류
5002API_KEY_INVALID유효하지 않거나 누락된 API 키
9010SCAN_TEXT_ERROR프롬프트가 콘텐츠 검토를 통과하지 못함
9038PROHIBITED_CONTENT생성된 이미지에 금지된 콘텐츠가 포함됨
9051COINS_NOT_ENOUGH크레딧 부족

전체 공통 오류 정의는 오류 코드 참조를 참고하세요.