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装飾スタイルの選択肢

各選択肢には nameidurl が含まれます。対応するリクエストフィールドに選択肢の 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❌ 任意列挙値: BasePro。既定値は 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_INVALIDAPI キーが無効または未指定
9010SCAN_TEXT_ERRORプロンプトがコンテンツ審査に通りませんでした
9038PROHIBITED_CONTENT生成画像に禁止された内容が含まれています
9051COINS_NOT_ENOUGHクレジット不足

共通エラーの完全な定義は、エラーコードリファレンスを参照してください。