虚拟样板间 API 文档#
基础 URL:
https://api.ideal.house
版本: v1
更新: 2026-04-13
📖 概述#
虚拟样板间 API 允许您使用 AI 重新设计空置或半家具房间。
提交房间图片 URL 和可选文本提示,然后异步获取生成结果。
- 创建任务 — 提交
imageUrl和可选的prompt,然后获取taskId。 - 轮询结果 — 使用
taskId查询任务状态并获取输出图片。
🔐 认证#
所有 API 请求必须使用 API 密钥进行认证。
在请求头中包含您的 API 密钥:
| 头字段 | 值 |
|---|---|
APIKEY | your_api_key_here |
⚠️ 保持您的 API 密钥安全。 切勿在客户端代码或公共仓库中暴露它。
💰 积分扣减#
[!WARNING] 🪙 任务成功创建时会扣除 1 积分。
如果任务最终失败,已扣除的积分将自动退还。
积分不足将返回错误码9051。📄 请参阅积分扣减参考。
| 操作 | 扣除积分 |
|---|---|
| 虚拟样板间任务 | 1 积分 |
📌 API 端点#
1. 创建虚拟样板间任务#
创建新的虚拟样板间任务,并返回用于轮询的唯一 taskId。
端点
POST /api/v1/virtualStaging/generate
请求头
| 头字段 | 必需 | 描述 |
|---|---|---|
APIKEY | ✅ 是 | 您的 API 认证密钥 |
Content-Type | ✅ 是 | application/json |
请求体
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
imageUrl | string | ✅ 是 | 源房间图片的 URL |
prompt | string | ❌ 否 | 可选提示,用于引导风格和家具布置 |
indoorTypeId | string | ❌ 否 | 可选房间类型预设。参见室内类型选项 |
indoorStyleId | string | ❌ 否 | 可选室内风格预设。参见室内风格选项 |
indoorElemId | string | ❌ 否 | 可选房间元素预设。支持多个 ID 用逗号连接,例如 id1,id2 |
🖼️ 图片要求: 使用 JPG/JPEG、PNG 或 WebP。每张图片不得超过 20 MB,尺寸从 128 × 128 像素到 6,000 × 6,000 像素(含)。超出最大像素尺寸的图片会自动按比例缩放以适配 6,000 × 6,000 像素后再处理。图片 URL 必须由 API 服务器直接访问。
🎨 风格选项#
indoorTypeId、indoorStyleId 和 indoorElemId 可从 API 风格配置 端点中选择。
使用方式:
GET /api/v1/style/virtual_staging/getStyles
| 风格组 | 请求字段 | 描述 |
|---|---|---|
roomType | indoorTypeId | 房间类型选项 |
style | indoorStyleId | 室内风格选项 |
elements | indoorElemId | 房间元素选项。支持多个选项 ID 用逗号连接,例如 id1,id2 |
每个选项包含 name、id 和 url。将选项 id 传入对应请求字段。
📥 请求示例#
cURL
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)
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)
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)
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();
📤 响应#
成功响应
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| 字段 | 类型 | 描述 |
|---|---|---|
code | integer | 0 表示成功 |
message | string | 响应消息 |
data | long | 用于轮询结果的唯一任务 ID |
2. 获取任务结果#
获取先前创建的虚拟样板间任务的当前状态和输出。
端点
GET /api/v1/virtualStaging/result
请求头
| 头字段 | 必需 | 描述 |
|---|---|---|
APIKEY | ✅ 是 | 您的 API 认证密钥 |
查询参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
taskId | long | ✅ 是 | 创建任务端点返回的任务 ID |
📥 请求示例#
cURL
curl -X GET "https://api.ideal.house/api/v1/virtualStaging/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
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)
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)
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);
📤 响应#
成功响应(任务完成)
{
"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
}
}
}
响应(任务处理中/排队中)
{
"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
}
}
响应(任务失败)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/empty-room.jpg",
"prompt": "..."
},
"output": null
}
}
响应字段
| 字段 | 类型 | 描述 |
|---|---|---|
id | long | 任务唯一标识符 |
status | string | 当前任务状态(参见任务状态) |
waitNumber | integer | 队列中排在任务前的数量(0 表示正在处理中) |
percentage | integer | 任务完成百分比(0-100) |
errorReason | string | status 为 Failed 时的失败原因 |
input | object | 为此任务提交的原输入参数 |
input.imageUrl | string | 源房间图片 URL |
input.prompt | string | 用户提示(如有提供) |
input.indoorTypeId | string | 使用的房间类型预设(如有提供) |
input.indoorStyleId | string | 使用的室内风格预设(如有提供) |
input.indoorElemId | string | 使用的房间元素预设(如有提供)。可能包含多个用逗号连接的 ID |
output | object | 生成结果(仅当 status 为 Success 时可获取) |
output.resultUrl | string | 生成虚拟样板间结果图片的 URL |
output.width | integer | 输出图片宽度(像素) |
output.height | integer | 输出图片高度(像素) |
📊 任务状态#
| 状态 | 含义 |
|---|---|
Unprocessed | 任务已创建并在队列中等待 |
Processing | 任务正在运行中 |
Success | 任务成功完成 |
Failed | 任务失败,未产出任何输出 |
每 3-5 秒轮询一次。参见API 任务限制。
❌ 错误响应#
所有错误响应共享相同的 JSON 结构:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
错误码参考#
| 代码 | 名称 | 描述 | 建议操作 |
|---|---|---|---|
1001 | FAILED | 请求失败(通用错误) | 检查 message 字段获取具体详情 |
1003 | INTERNAL_ERROR | 内部服务器错误 | 稍作延迟后重试;如持续出现请联系支持团队 |
1011 | PARAM_ERROR | 请求参数错误(例如缺少 imageUrl) | 确保 imageUrl 已提供且为有效 URL |
5002 | API_KEY_INVALID | 无效或缺失的 API 密钥 | 确保 APIKEY 头字段存在且正确 |
9010 | SCAN_TEXT_ERROR | 提示词审核未通过 | 修改提示词,移除敏感或禁用内容 |
9038 | PROHIBITED_CONTENT | 生成输出图片包含禁用内容 | 调整提示词/风格/输入并重试 |
9051 | COINS_NOT_ENOUGH | 积分不足 | 充值积分后重试 |
📄 完整通用错误定义,参见错误码参考。