Ideal House
ข้ามไปยังเนื้อหา

เอกสาร API จัดเฟอร์นิเจอร์เสมือนจริง#

** URL พื้นฐาน:** https://api.ideal.house
เวอร์ชัน: v1
อัปเดต: 2026-04-13


📖 ภาพรวม#

API จัดเฟอร์นิเจอร์เสมือนจริง ช่วยให้คุณออกแบบใหม่ห้องว่างหรือห้องที่มีเฟอร์นิเจอร์บางส่วนโดยใช้ AI
คุณส่ง URL ของภาพห้องและข้อความสั่ง (prompt) (ไม่บังคับ) จากนั้นรับผลลัพธ์ที่สร้างเสร็จแบบไม่ซิงโครนัส

  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❌ ไม่ค่าตั้งต้นองค์ประกอบห้องแบบไม่บังคับ รองรับหลาย 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
กลุ่มสไตล์ฟิลด์คำขอคำอธิบาย
roomTypeindoorTypeIdตัวเลือกประเภทห้อง
styleindoorStyleIdตัวเลือกสไตล์ภายใน
elementsindoorElemIdตัวเลือกองค์ประกอบห้อง รองรับหลาย ID ที่เชื่อมด้วยเครื่องหมายจุลภาค เช่น id1,id2

แต่ละตัวเลือกมี name, id และ url ส่ง 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ข้อความคำตอบ
datalongID งานที่ไม่ซ้ำกันสำหรับการตรวจสอบสถานะ

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)
errorReasonstringเหตุผลที่ล้มเหลวเมื่อ status เป็น Failed
inputobjectพารามิเตอร์อินพุตต้นฉบับที่ส่งสำหรับงานนี้
input.imageUrlstringURL ของภาพห้องต้นทาง
input.promptstringคำสั่งงานของผู้ใช้ (ถ้ามี)
input.indoorTypeIdstringค่าตั้งต้นประเภทห้องที่ใช้ (ถ้ามี)
input.indoorStyleIdstringค่าตั้งต้นสไตล์ภายในที่ใช้ (ถ้ามี)
input.indoorElemIdstringค่าตั้งต้นองค์ประกอบห้องที่ใช้ (ถ้ามี) อาจมีหลาย ID ที่เชื่อมด้วยเครื่องหมายจุลภาค
outputobjectผลลัพธ์การสร้าง (มีเฉพาะเมื่อ status เป็น Success)
output.resultUrlstringURL ของภาพผลลัพธ์การจัดเฟอร์นิเจอร์เสมือนจริงที่สร้าง
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_INVALIDคีย์ API ไม่ถูกต้องหรือไม่พบตรวจสอบว่าหัว APIKEY มีอยู่และถูกต้อง
9010SCAN_TEXT_ERRORคำสั่งงานไม่ผ่านการตรวจสอบเนื้อหาแก้ไขคำสั่งงานเพื่อลบเนื้อหาที่อ่อนไหวหรือห้ามใช้
9038PROHIBITED_CONTENTภาพผลลัพธ์ที่สร้างมีเนื้อหาที่ห้ามใช้ปรับคำสั่งงาน/สไตล์/อินพุตและลองใหม่
9051COINS_NOT_ENOUGHเครดิตไม่เพียงพอเติมเครดิตและลองใหม่

📄 สำหรับคำนิยามข้อผิดพลาดทั่วไปทั้งหมด ดู อ้างอิงรหัสข้อผิดพลาด