เอกสาร API ตกแต่งบ้าน#
** URL พื้นฐาน:**
https://api.ideal.house
เวอร์ชัน: v1
อัปเดต: 2026-05-21
📖 ภาพรวม#
API ตกแต่งบ้าน สร้างไอเดียการตกแต่งสำหรับภาพภายใน รองรับคำแนะนำข้อความแบบไม่บังคับ ภาพอ้างอิง การเลือกสไตล์ และโหมดโมเดล
เวิร์กโฟลว์เป็นแบบไม่ซิงโครนัส:
- สร้างงาน — ส่ง
imageUrlและพารามิเตอร์แบบไม่บังคับ จากนั้นรับtaskId - ตรวจสอบผลลัพธ์ — ใช้
taskIdเพื่อดึงสถานะงานและภาพที่สร้าง
🔐 การยืนยันตัวตน#
| หัว | ค่า |
|---|---|
APIKEY | your_api_key_here |
💰 การหักเครดิต#
[!WARNING] เครดิตจะถูกหักเมื่อสร้างงานสำเร็จ หากงาน ล้มเหลว ในที่สุด เครดิตที่ถูกหักจะ คืนอัตโนมัติ
หากเครดิตไม่เพียงพอ จะคืนค่ารหัสข้อผิดพลาด9051ดู อ้างอิงการหักเครดิต
โมเดล (modelType) | เครดิตที่ถูกหัก |
|---|---|
Base | เครดิต 3 |
Pro | เครดิต 10 |
หากไม่ระบุ modelType จะใช้ Base เป็นค่าเริ่มต้น
🎨 ตัวเลือกสไตล์#
API นี้รองรับพารามิเตอร์สไตล์แบบไม่บังคับที่คืนโดยจุดเชื่อมต่อ API การตั้งค่าสไตล์
ใช้:
GET /api/v1/style/home_decor_ideas/getStyles
| กลุ่มสไตล์ | ฟิลด์คำขอ | คำอธิบาย |
|---|---|---|
spaceType | spaceStyleId | ตัวเลือกประเภทพื้นที่หรือห้อง |
decorStyle | homeDecorStyleId | ตัวเลือกสไตล์การตกแต่ง |
แต่ละตัวเลือกมี name, id และ url ส่ง id ของตัวเลือกไปยังฟิลด์คำขอที่สอดคล้องกัน
📌 API จุดเชื่อมต่อ#
1. สร้างงานตกแต่งบ้าน#
จุดเชื่อมต่อ
POST /api/v1/homeDecor/generate
หัวคำขอ
| หัว | จำเป็น | คำอธิบาย |
|---|---|---|
APIKEY | ✅ ใช่ | คีย์ API สำหรับยืนยันตัวตนของคุณ |
Content-Type | ✅ ใช่ | application/json |
เนื้อหาคำขอ
| ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
imageUrl | string | ✅ ใช่ | URL ของภาพภายในต้นทาง |
referenceUrl | string | ❌ ไม่บังคับ | URL ของภาพอ้างอิงเพื่อแนะนำสไตล์การตกแต่ง |
spaceStyleId | string | ❌ ไม่บังคับ | ID ประเภทพื้นที่จากตัวเลือกสไตล์ spaceType |
homeDecorStyleId | string | ❌ ไม่บังคับ | ID สไตล์ตกแต่งจากตัวเลือกสไตล์ decorStyle |
prompt | string | ❌ ไม่บังคับ | คำแนะนำข้อความสำหรับผลลัพธ์ที่ต้องการ |
modelType | string | ❌ ไม่บังคับ | Enum: Base, Pro ค่าเริ่มต้นคือ Base |
เฉพาะ
imageUrlเท่านั้นที่จำเป็น ฟิลด์อื่นทั้งหมดเป็นแบบไม่บังคับ
🖼️ ข้อกำหนดของภาพ: ภาพต้นทางและภาพอ้างอิงทั้งหมดต้องใช้ JPG/JPEG, PNG หรือ WebP แต่ละภาพต้องมีขนาดไม่เกิน 20 MB โดยมีขนาดตั้งแต่ 128 × 128 px ถึง 6,000 × 6,000 px (รวมขอบเขต) ภาพที่มีขนาดพิกเซลเกินค่าสูงสุดจะถูกย่อขนาดลงตามสัดส่วนให้พอดีกับ 6,000 × 6,000 px ก่อนประมวลผล URLs ของภาพต้องเข้าถึงได้โดยตรงโดยเซิร์ฟเวอร์ API
📥 ตัวอย่างคำขอ#
cURL
curl -X POST "https://api.ideal.house/api/v1/homeDecor/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"referenceUrl": "https://example.com/reference.jpg",
"spaceStyleId": "Indoor_Living Room",
"homeDecorStyleId": "Holidays_Cozy Christmas",
"prompt": "warm seasonal decor with natural textures",
"modelType": "Base"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class HomeDecorApiExample {
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/room.jpg",
"referenceUrl": "https://example.com/reference.jpg",
"spaceStyleId": "Indoor_Living Room",
"homeDecorStyleId": "Holidays_Cozy Christmas",
"prompt": "warm seasonal decor with natural textures",
"modelType": "Base"
}
""";
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/homeDecor/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/room.jpg",
"referenceUrl": "https://example.com/reference.jpg",
"spaceStyleId": "Indoor_Living Room",
"homeDecorStyleId": "Holidays_Cozy Christmas",
"prompt": "warm seasonal decor with natural textures",
"modelType": "Base"
}
response = requests.post(
f"{BASE_URL}/api/v1/homeDecor/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 createHomeDecorTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/homeDecor/generate`,
{
imageUrl: 'https://example.com/room.jpg',
referenceUrl: 'https://example.com/reference.jpg',
spaceStyleId: 'Indoor_Living Room',
homeDecorStyleId: 'Holidays_Cozy Christmas',
prompt: 'warm seasonal decor with natural textures',
modelType: 'Base'
},
{
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);
}
}
createHomeDecorTask();
📤 คำตอบ#
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
2. รับผลลัพธ์งาน#
จุดเชื่อมต่อ
GET /api/v1/homeDecor/result
หัวคำขอ
| หัว | จำเป็น | คำอธิบาย |
|---|---|---|
APIKEY | ✅ ใช่ | คีย์ API สำหรับยืนยันตัวตนของคุณ |
พารามิเตอร์คิวรี
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
taskId | long | ✅ ใช่ | ID งานที่คืนโดยจุดเชื่อมต่อสร้าง |
📥 ตัวอย่างคำขอ#
cURL
curl -X GET "https://api.ideal.house/api/v1/homeDecor/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class HomeDecorResultExample {
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/homeDecor/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/homeDecor/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)
const axios = require('axios');
const BASE_URL = 'https://api.ideal.house';
const API_KEY = 'your_api_key_here';
async function pollHomeDecorResult(taskId) {
const headers = { APIKEY: API_KEY };
while (true) {
const response = await axios.get(
`${BASE_URL}/api/v1/homeDecor/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));
}
}
pollHomeDecorResult(1234567890123456789n);
📤 ตัวอย่างคำตอบ#
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/room.jpg",
"refImageUrl": "https://example.com/reference.jpg",
"spaceStyleId": "Indoor_Living Room",
"homeDecorStyleId": "Holidays_Cozy Christmas",
"prompt": "warm seasonal decor with natural textures",
"modelType": "Base"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/home_decor_result.jpg",
"width": 1024,
"height": 1024
}
}
}
คำตอบ (งานกำลังประมวลผล / อยู่ในคิว)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 45,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Base"
},
"output": null
}
}
คำตอบ (งานล้มเหลว)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Base"
},
"output": null
}
}
📊 สถานะงาน#
| สถานะ | คำอธิบาย |
|---|---|
Unprocessed | งานถูกสร้างแล้วและกำลังรอในคิว |
Processing | งานกำลังดำเนินการอยู่ |
Success | งานเสร็จสมบูรณ์ |
Failed | งานล้มเหลวและไม่มีผลลัพธ์ |
ตรวจสอบสถานะทุก 3-5 วินาที ดู API ขีดจำกัดงาน
❌ คำตอบข้อผิดพลาด#
| รหัส | ชื่อ | คำอธิบาย |
|---|---|---|
1011 | PARAM_ERROR | ข้อผิดพลาดพารามิเตอร์คำขอ |
5002 | API_KEY_INVALID | คีย์ API ไม่ถูกต้องหรือไม่พบ |
9010 | SCAN_TEXT_ERROR | คำสั่งงานไม่ผ่านการตรวจสอบเนื้อหา |
9038 | PROHIBITED_CONTENT | ภาพที่สร้างมีเนื้อหาที่ห้ามใช้ |
9051 | COINS_NOT_ENOUGH | เครดิตไม่เพียงพอ |
สำหรับคำนิยามข้อผิดพลาดทั่วไปทั้งหมด ดู อ้างอิงรหัสข้อผิดพลาด