Ideal House
跳转到主要内容

室内改造 API 文档#

基础 URL: https://api.ideal.house
版本: v1
更新日期: 2026-05-21


📖 概述#

室内改造 API 可对室内图片进行改造,并可选使用房间风格选项、文本指导和颜色指导。

工作流程是异步的:

  1. 创建任务 — 提交 imageUrl 及可选参数,然后接收一个 taskId
  2. 轮询结果 — 使用 taskId 获取任务状态和生成的图片。

🔐 认证#

请求头
APIKEYyour_api_key_here

💰 积分扣除#

[!WARNING] 🪙 1 积分 在任务成功创建时扣除。如果任务最终失败,已扣除的积分将自动退还
积分不足时将返回错误码 9051。参见积分扣除参考

操作扣除积分
室内改造任务1 积分

🎨 风格选项#

此 API 支持由 API 风格配置 接口返回的可选风格参数。

使用方式:

纯文本
GET /api/v1/style/interoir_remodel/getStyles
风格分组请求字段说明
roomTypeindoorTypeId房间类型选项
styleindoorStyleId室内风格选项
elementsindoorElemId房间元素选项。支持多个选项 ID 以逗号连接,例如 id1,id2

每个选项包含 nameidurl。将选项 id 传入对应的请求字段。


🎨 颜色指导#

colorStringcolorImgUrl 是可选的颜色指导输入:

情况行为
仅提供 colorString使用 colorString
仅提供 colorImgUrl使用颜色参考图片
两者均提供colorString 优先
均未提供颜色指导默认为 auto

📌 API 端点#

1. 创建室内改造任务#

端点

纯文本
POST /api/v1/interiorRemodel/generate

请求头

请求头必填说明
APIKEY✅ 是您的 API 认证密钥
Content-Type✅ 是application/json

请求体

字段类型必填说明
imageUrlstring✅ 是源室内图片的 URL
promptstring❌ 可选期望改造效果的文本指导
indoorTypeIdstring❌ 可选来自 roomType 风格选项的房间类型 ID
indoorStyleIdstring❌ 可选来自 style 风格选项的室内风格 ID
indoorElemIdstring❌ 可选来自 elements 风格选项的房间元素 ID。支持多个 ID 以逗号连接,例如 id1,id2
colorStringstring❌ 可选配色方案字符串,例如 [[174,238,238],[36,36,36]]
colorImgUrlstring❌ 可选颜色参考图片 URL

imageUrl 为必填项。所有其他字段均为可选。

🖼️ 图片要求: 所有源图片和参考图片必须使用 JPG/JPEG、PNG 或 WebP 格式。每张图片不得超过 20 MB,尺寸范围为 128 × 128 px6,000 × 6,000 px(含边界)。超过最大像素尺寸的图片将按比例缩小以适配 6,000 × 6,000 px 后再处理。图片 URLs 必须可直接被 API 服务器访问。

📥 请求示例#

cURL
bash
curl -X POST "https://api.ideal.house/api/v1/interiorRemodel/generate" \
  -H "APIKEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "imageUrl": "https://example.com/interior.jpg",
    "prompt": "modern warm remodel with clean built-in storage",
    "indoorTypeId": "Interior Design_Interior Scene_Living Room",
    "indoorStyleId": "Interior_Interior Style_Popular_Modern Country",
    "indoorElemId": "Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table",
    "colorString": "[[174,238,238],[36,36,36],[117,64,95]]"
  }'
Java (OkHttp)
java
import okhttp3.*;

import java.io.IOException;

public class InteriorRemodelApiExample {

    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/interior.jpg",
                    "prompt": "modern warm remodel with clean built-in storage",
                    "indoorTypeId": "Interior Design_Interior Scene_Living Room",
                    "indoorStyleId": "Interior_Interior Style_Popular_Modern Country",
                    "indoorElemId": "Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table",
                    "colorString": "[[174,238,238],[36,36,36],[117,64,95]]"
                }
                """;

        Request request = new Request.Builder()
                .url(BASE_URL + "/api/v1/interiorRemodel/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/interior.jpg",
    "prompt": "modern warm remodel with clean built-in storage",
    "indoorTypeId": "Interior Design_Interior Scene_Living Room",
    "indoorStyleId": "Interior_Interior Style_Popular_Modern Country",
    "indoorElemId": "Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table",
    "colorString": "[[174,238,238],[36,36,36],[117,64,95]]"
}

response = requests.post(
    f"{BASE_URL}/api/v1/interiorRemodel/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 createInteriorRemodelTask() {
  try {
    const response = await axios.post(
      `${BASE_URL}/api/v1/interiorRemodel/generate`,
      {
        imageUrl: 'https://example.com/interior.jpg',
        prompt: 'modern warm remodel with clean built-in storage',
        indoorTypeId: 'Interior Design_Interior Scene_Living Room',
        indoorStyleId: 'Interior_Interior Style_Popular_Modern Country',
        indoorElemId: 'Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table',
        colorString: '[[174,238,238],[36,36,36],[117,64,95]]'
      },
      {
        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);
  }
}

createInteriorRemodelTask();

📤 响应#

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

2. 获取任务结果#

端点

纯文本
GET /api/v1/interiorRemodel/result

请求头

请求头必填说明
APIKEY✅ 是您的 API 认证密钥

查询参数

参数类型必填说明
taskIdlong✅ 是由创建接口返回的任务 ID

📥 请求示例#

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

import java.io.IOException;

public class InteriorRemodelResultExample {

    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/interiorRemodel/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/interiorRemodel/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 pollInteriorRemodelResult(taskId) {
  const headers = { APIKEY: API_KEY };

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

pollInteriorRemodelResult(1234567890123456789n);

📤 响应示例#

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Success",
    "waitNumber": 0,
    "percentage": 100,
    "input": {
      "imageUrl": "https://example.com/interior.jpg",
      "prompt": "modern warm remodel with clean built-in storage",
      "indoorTypeId": "Interior Design_Interior Scene_Living Room",
      "indoorStyleId": "Interior_Interior Style_Popular_Modern Country",
      "colorString": "[[174,238,238],[36,36,36],[117,64,95]]"
    },
    "output": {
      "resultUrl": "https://cdn.ideal.house/output/interior_remodel_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/interior.jpg",
      "prompt": "modern warm remodel with clean built-in storage"
    },
    "output": null
  }
}

响应(任务失败)

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

📊 任务状态#

状态说明
Unprocessed任务已创建并等待处理
Processing任务正在处理中
Success任务成功完成
Failed任务失败且未产生输出

3-5 秒 轮询一次。参见API 任务限制


❌ 错误响应#

错误码名称说明
1011PARAM_ERROR请求参数错误
5002API_KEY_INVALID无效或缺失的 API 密钥
9010SCAN_TEXT_ERROR提示词审核未通过
9038PROHIBITED_CONTENT生成的图片包含禁止内容
9051COINS_NOT_ENOUGH积分不足

如需完整的常见错误定义,参见错误码参考