Ideal House
コンテンツにスキップ

バーチャルステージング API ドキュメント#

ベース URL: https://api.ideal.house
バージョン: v1
更新日: 2026-04-13


📖 概要#

バーチャルステージング API は、AI を使って空室または一部に家具のある部屋を再デザインします。
部屋の画像の URL と任意のテキストプロンプトを送信し、生成結果を非同期で取得します。

  1. タスクを作成するimageUrl と任意の prompt を送信し、taskId を受け取ります。
  2. 結果をポーリングするtaskId でタスクの状態を照会し、出力画像を取得します。

🔐 認証#

すべての API リクエストは API キー で認証する必要があります。

リクエストヘッダーに API キーを含めます。

ヘッダー
APIKEYyour_api_key_here

⚠️ API キーは安全に保管してください。 クライアント側のコードや公開リポジトリに公開しないでください。


💰 クレジットの消費#

[!WARNING] 🪙 タスクが正常に作成されると 1 クレジット が差し引かれます。
タスクが最終的に 失敗 した場合、差し引かれたクレジットは 自動的に返還 されます。
クレジット不足の場合、エラーコード 9051 が返ります。📄 クレジット消費リファレンスを参照してください。

操作消費クレジット
バーチャルステージングタスク1 クレジット

📌 API エンドポイント#


1. バーチャルステージングタスクの作成#

新しいバーチャルステージングタスクを作成し、ポーリング用の一意の taskId を返します。

エンドポイント

プレーンテキスト
POST /api/v1/virtualStaging/generate

リクエストヘッダー

ヘッダー必須説明
APIKEY✅ はいAPI の認証キー
Content-Type✅ はいapplication/json

リクエストボディ

フィールド必須説明
imageUrlstring✅ はい元の部屋画像の URL
promptstring❌ いいえスタイルと家具配置を指定する任意のプロンプト
indoorTypeIdstring❌ いいえ任意の部屋の種類のプリセット。部屋の種類の選択肢を参照
indoorStyleIdstring❌ いいえ任意のインテリアスタイルのプリセット。インテリアスタイルの選択肢を参照
indoorElemIdstring❌ いいえ任意の部屋の要素のプリセット。id1,id2 のように複数の ID をカンマで連結できます

🖼️ 画像の要件: JPG/JPEG、PNG、WebP のいずれかを使用します。各画像は 20 MB 以下で、寸法は 128 × 128 px 以上 6,000 × 6,000 px 以下です。最大ピクセル寸法を超える画像は、処理前に 6,000 × 6,000 px 以内に収まるよう縦横比を保って自動縮小されます。画像の URL は API サーバーから直接アクセスできる必要があります。


🎨 スタイルの選択肢#

indoorTypeIdindoorStyleIdindoorElemId は、API スタイル設定エンドポイントから選択できます。

使用するエンドポイント:

プレーンテキスト
GET /api/v1/style/virtual_staging/getStyles
スタイルグループリクエストフィールド説明
roomTypeindoorTypeId部屋の種類の選択肢
styleindoorStyleIdインテリアスタイルの選択肢
elementsindoorElemId部屋の要素の選択肢。id1,id2 のように複数の選択肢の ID をカンマで連結できます

各選択肢には nameidurl が含まれます。対応するリクエストフィールドに選択肢の id を渡します。


📥 リクエスト例#

cURL
bash
curl -X POST "https://api.ideal.house/api/v1/virtualStaging/generate" \
  -H "APIKEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "imageUrl": "https://example.com/empty-living-room.jpg",
    "prompt": "Warm and modern living room styling",
    "indoorTypeId": "Interior Design_Interior Scene_Living Room",
    "indoorStyleId": "Interior_Interior Style_Popular_Vs_Modern Farmhouse",
    "indoorElemId": "Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table"
  }'
Java (OkHttp)
java
import okhttp3.*;

import java.io.IOException;

public class VirtualStagingApiExample {

    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/empty-bedroom.jpg",
                    "prompt": "Cozy contemporary bedroom",
                    "indoorTypeId": "Interior Design_Interior Scene_Bed Room",
                    "indoorStyleId": "Interior_Interior Style_Popular_Vs_Contemporary Warm",
                    "indoorElemId": "Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table"
                }
                """;

        Request request = new Request.Builder()
                .url(BASE_URL + "/api/v1/virtualStaging/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/empty-home-office.jpg",
    "prompt": "Minimal modern home office",
    "indoorTypeId": "Interior Design_Interior Scene_Home Office",
    "indoorStyleId": "Interior_Interior Style_Popular_Vs_Modern Minimal",
    "indoorElemId": "Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table"
}

response = requests.post(
    f"{BASE_URL}/api/v1/virtualStaging/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 createVirtualStagingTask() {
  try {
    const response = await axios.post(
      `${BASE_URL}/api/v1/virtualStaging/generate`,
      {
        imageUrl: 'https://example.com/empty-dining-room.jpg',
        prompt: 'Modern luxury dining room',
        indoorTypeId: 'Interior Design_Interior Scene_Dining Room',
        indoorStyleId: 'Interior_Interior Style_Popular_Vs_Modern Luxury',
        indoorElemId: 'Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table'
      },
      {
        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);
  }
}

createVirtualStagingTask();

📤 レスポンス#

成功時のレスポンス

json
{
  "code": 0,
  "message": "success",
  "data": 1234567890123456789
}
フィールド説明
codeinteger0 は成功を示します
messagestringレスポンスのメッセージ
datalong結果をポーリングするための一意のタスク ID

2. タスク結果の取得#

作成済みのバーチャルステージングタスクの現在の状態と出力を取得します。

エンドポイント

プレーンテキスト
GET /api/v1/virtualStaging/result

リクエストヘッダー

ヘッダー必須説明
APIKEY✅ はいAPI の認証キー

クエリパラメーター

パラメーター必須説明
taskIdlong✅ はいタスク作成エンドポイントから返されたタスク ID

📥 リクエスト例#

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

import java.io.IOException;

public class VirtualStagingResultExample {

    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/virtualStaging/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/virtualStaging/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":
    output = result["output"]
    print("Result URL:", output["resultUrl"])
    print("Size:", output["width"], "x", output["height"])
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 pollResult(taskId) {
  const headers = { 'APIKEY': API_KEY };

  while (true) {
    const response = await axios.get(
      `${BASE_URL}/api/v1/virtualStaging/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));
  }
}

pollResult(1234567890123456789n);

📤 レスポンス#

成功時のレスポンス(タスク完了)

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Success",
    "waitNumber": 0,
    "percentage": 100,
    "input": {
      "imageUrl": "https://example.com/empty-room.jpg",
      "prompt": "modern country living room with warm neutral materials",
      "indoorTypeId": "Interior Design_Interior Scene_Living Room",
      "indoorStyleId": "Interior_Interior Style_Popular_Vs_Modern Farmhouse",
      "indoorElemId": "Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table"
    },
    "output": {
      "resultUrl": "https://cdn.ideal.house/output/virtual_staging_result.jpg",
      "width": 1024,
      "height": 1024
    }
  }
}

レスポンス(タスク処理中または待機中)

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Processing",
    "waitNumber": 1,
    "percentage": 46,
    "input": {
      "imageUrl": "https://example.com/empty-room.jpg",
      "prompt": "coastal bedroom with soft light and natural textures",
      "indoorTypeId": "Interior Design_Interior Scene_Bed Room",
      "indoorStyleId": "Interior_Interior Style_Popular_Vs_Contemporary Warm"
    },
    "output": null
  }
}

レスポンス(タスク失敗)

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

レスポンスのフィールド

フィールド説明
idlongタスクの一意の識別子
statusstring現在のタスクの状態(タスクの状態を参照)
waitNumberintegerキュー内で前に並んでいるタスクの数(0 は現在処理中であることを示します)
percentageintegerタスクの完了率(0-100
errorReasonstringstatusFailed の場合の失敗理由
inputobjectこのタスクで送信した元の入力パラメーター
input.imageUrlstring元の部屋画像の URL
input.promptstringユーザーのプロンプト(指定した場合)
input.indoorTypeIdstring使用した部屋の種類のプリセット(指定した場合)
input.indoorStyleIdstring使用したインテリアスタイルのプリセット(指定した場合)
input.indoorElemIdstring使用した部屋の要素のプリセット(指定した場合)。複数の ID がカンマで連結されている場合があります
outputobject生成結果(statusSuccess の場合のみ利用可能)
output.resultUrlstring生成されたバーチャルステージングの結果画像の URL
output.widthinteger出力画像の幅(ピクセル単位)
output.heightinteger出力画像の高さ(ピクセル単位)

📊 タスクの状態#

状態意味
Unprocessedタスクが作成され、キューで待機しています
Processingタスクは現在実行中です
Successタスクが正常に完了しました
Failedタスクが失敗し、出力は生成されませんでした

3-5 秒 ごとにポーリングしてください。API タスク制限を参照してください。


❌ エラーレスポンス#

すべてのエラーレスポンスは同じ JSON 構造を使用します。

json
{
  "code": 5002,
  "message": "Invalid API Key",
  "data": null
}

エラーコードリファレンス#

コード名前説明推奨される対応
1001FAILEDリクエストの失敗(一般的なエラー)message フィールドで詳細を確認する
1003INTERNAL_ERRORサーバー内部のエラー少し待って再試行し、解消しない場合はサポートに連絡する
1011PARAM_ERRORリクエストパラメーターのエラー(例: imageUrl が未指定)imageUrl が指定され、有効な URL であることを確認する
5002API_KEY_INVALIDAPI キーが無効または未指定APIKEY ヘッダーが存在し、正しいことを確認する
9010SCAN_TEXT_ERRORプロンプトがコンテンツ審査に通りませんでしたプロンプトを修正し、機微な内容や禁止された内容を除く
9038PROHIBITED_CONTENT生成された出力画像に禁止された内容が含まれていますプロンプト、スタイル、入力を調整して再試行する
9051COINS_NOT_ENOUGHクレジット不足クレジットを追加して再試行する

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