وثائق تغيير الأثاث API#
الـ URL الأساسي:
https://api.ideal.house
الإصدار: v1
تم التحديث: 2026-05-21
📖 نظرة عامة#
يقوم تغيير الأثاث API بإعادة تنسيق أو تغيير الأثاث في صورة داخلية. أرسل صورة مصدر وموجهات نمط اختيارية، ثم استعلم دوريًا عن نتيجة المهمة بشكل غير متزامن.
- إنشاء مهمة — أرسل
imageUrlوالموجهات الاختيارية، ثم احصل علىtaskId. - الاستعلام الدوري للحصول على النتائج — استخدم
taskIdللاستفسار عن حالة المهمة وصورة الإخراج.
🔐 المصادقة#
يجب أن تتضمن جميع طلبات API مفتاح API في رأس الطلب.
| الرأس | القيمة |
|---|---|
APIKEY | your_api_key_here |
💰 خصم الرصيد#
[!WARNING] 🪙 يُخصم 1 رصيد عند إنشاء المهمة بنجاح. إذا فشلت المهمة في النهاية، يُعاد الرصيد المخصوم تلقائيًا.
سيؤدي نقص الرصيد إلى إرجاع رمز الخطأ9051. انظر مرجع خصم الرصيد.
| العملية | الرصيد المخصوم |
|---|---|
| مهمة تغيير الأثاث | 1 رصيد |
🎨 خيارات النمط#
تدعم هذه API معلمات أنماط اختيارية تُرجعها نقطة نهاية إعداد أنماط API.
استخدم:
GET /api/v1/style/change_furniture/getStyles
| مجموعة النمط | حقل الطلب | الوصف |
|---|---|---|
roomType | indoorTypeId | خيار نوع الغرفة |
style | indoorStyleId | خيار النمط الداخلي |
elements | indoorElemId | خيار عنصر الغرفة. يدعم عدة معرفات خيارات مفصولة بفاصلة، على سبيل المثال id1,id2 |
يحتوي كل خيار على:
| الحقل | الوصف |
|---|---|
name | اسم الخيار متعدد اللغات |
id | القيمة المراد تمريرها في حقل الطلب |
url | صورة معاينة للخيار |
📌 API نقاط النهاية#
1. إنشاء مهمة تغيير الأثاث#
نقطة النهاية
POST /api/v1/changeFurniture/generate
رؤوس الطلب
| الرأس | مطلوب | الوصف |
|---|---|---|
APIKEY | ✅ نعم | مفتاح مصادقة API الخاص بك |
Content-Type | ✅ نعم | application/json |
جسم الطلب
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
imageUrl | string | ✅ نعم | URL للصورة الداخلية المصدر |
prompt | string | ❌ اختياري | توجيه نصي للنتيجة المطلوبة |
indoorTypeId | string | ❌ اختياري | معرف نوع الغرفة من خيارات roomType |
indoorStyleId | string | ❌ اختياري | معرف النمط الداخلي من خيارات style |
indoorElemId | string | ❌ اختياري | معرف عنصر الغرفة من خيارات elements. يدعم عدة معرفات مفصولة بفاصلة، على سبيل المثال id1,id2 |
فقط
imageUrlمطلوب. جميع الحقول الأخرى اختيارية.
🖼️ متطلبات الصور: استخدم JPG/JPEG، أو PNG، أو WebP. يجب ألا يتجاوز حجم كل صورة 20 ميجابايت، مع أبعاد تتراوح من 128 × 128 بكسل إلى 6,000 × 6,000 بكسل (شامل). تتم عملية تصغير الصور التي تتجاوز الأبعاد البكسلية القصوى تلقائيًا بشكل متناسب لتناسب 6,000 × 6,000 بكسل قبل المعالجة. يجب أن تكون URL للصور قابلة للوصول مباشرة من قبل خادم API.
📥 أمثلة الطلب#
cURL
curl -X POST "https://api.ideal.house/api/v1/changeFurniture/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/living-room.jpg",
"prompt": "replace the sofa with a modern warm neutral sofa",
"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"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class ChangeFurnitureApiExample {
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/living-room.jpg",
"prompt": "replace the sofa with a modern warm neutral sofa",
"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"
}
""";
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/changeFurniture/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/living-room.jpg",
"prompt": "replace the sofa with a modern warm neutral sofa",
"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"
}
response = requests.post(
f"{BASE_URL}/api/v1/changeFurniture/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 createChangeFurnitureTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/changeFurniture/generate`,
{
imageUrl: 'https://example.com/living-room.jpg',
prompt: 'replace the sofa with a modern warm neutral sofa',
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'
},
{
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);
}
}
createChangeFurnitureTask();
📤 الاستجابة#
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| الحقل | النوع | الوصف |
|---|---|---|
code | integer | يشير 0 إلى النجاح |
message | string | رسالة الاستجابة |
data | long | معرف المهمة للاستعلام الدوري عن النتائج |
2. الحصول على نتيجة المهمة#
نقطة النهاية
GET /api/v1/changeFurniture/result
رؤوس الطلب
| الرأس | مطلوب | الوصف |
|---|---|---|
APIKEY | ✅ نعم | مفتاح مصادقة API الخاص بك |
معاملات الاستعلام
| المعامل | النوع | مطلوب | الوصف |
|---|---|---|---|
taskId | long | ✅ نعم | معرف المهمة المُرجع بواسطة نقطة نهاية الإنشاء |
📥 أمثلة الطلب#
cURL
curl -X GET "https://api.ideal.house/api/v1/changeFurniture/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class ChangeFurnitureResultExample {
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/changeFurniture/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/changeFurniture/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 pollChangeFurnitureResult(taskId) {
const headers = { APIKEY: API_KEY };
while (true) {
const response = await axios.get(
`${BASE_URL}/api/v1/changeFurniture/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));
}
}
pollChangeFurnitureResult(1234567890123456789n);
📤 مثال الاستجابة#
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/living-room.jpg",
"prompt": "replace the sofa with a modern warm neutral sofa",
"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"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/change_furniture_result.jpg",
"width": 1024,
"height": 1024
}
}
}
الاستجابة (معالجة المهمة / في الطابور)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 45,
"input": {
"imageUrl": "https://example.com/living-room.jpg",
"prompt": "replace the sofa with a modern warm neutral sofa"
},
"output": null
}
}
الاستجابة (فشل المهمة)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/living-room.jpg"
},
"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 | رصيد غير كافٍ |
للتعريفات الكاملة للأخطاء الشائعة، انظر مرجع رموز الأخطاء.