เอกสาร API จัดเฟอร์นิเจอร์เสมือนจริง#
** URL พื้นฐาน:**
https://api.ideal.house
เวอร์ชัน: v1
อัปเดต: 2026-04-13
📖 ภาพรวม#
API จัดเฟอร์นิเจอร์เสมือนจริง ช่วยให้คุณออกแบบใหม่ห้องว่างหรือห้องที่มีเฟอร์นิเจอร์บางส่วนโดยใช้ AI
คุณส่ง URL ของภาพห้องและข้อความสั่ง (prompt) (ไม่บังคับ) จากนั้นรับผลลัพธ์ที่สร้างเสร็จแบบไม่ซิงโครนัส
- สร้างงาน — ส่ง
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 px ถึง 6,000 × 6,000 px (รวมขอบเขต) ภาพที่มีขนาดพิกเซลเกินค่าสูงสุดจะถูกย่อขนาดลงตามสัดส่วนให้พอดีกับ 6,000 × 6,000 px ก่อนประมวลผล 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 | เครดิตไม่เพียงพอ | เติมเครดิตและลองใหม่ |
📄 สำหรับคำนิยามข้อผิดพลาดทั่วไปทั้งหมด ดู อ้างอิงรหัสข้อผิดพลาด