توثيق 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 | ❌ اختياري | معرّف نوع المساحة من خيارات spaceType |
homeDecorStyleId | string | ❌ اختياري | معرّف نمط الديكور من خيارات decorStyle |
prompt | string | ❌ اختياري | إرشادات نصية للنتيجة المطلوبة |
modelType | string | ❌ اختياري | القيم الممكنة: Base، Pro. الافتراضي Base |
فقط
imageUrlمطلوب. جميع الحقول الأخرى اختيارية.
🖼️ متطلبات الصورة: يجب أن تستخدم جميع صور المصدر والمرجعية JPG/JPEG أو PNG أو WebP. يجب ألا يتجاوز حجم كل صورة 20 ميجابايت، وأبعادها من 128 × 128 بكسل إلى 6,000 × 6,000 بكسل (بما في ذلك). تتم تصغير الصور التي تتجاوز أبعاد البكسل القصوى تلقائياً بشكل متناسب لتناسب 6,000 × 6,000 بكسل قبل المعالجة. يجب أن تكون 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 | ✅ نعم | معرف المهمة المعاد من نقطة النهاية للإنشاء |
📥 أمثلة على الطلب#
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 | رصيد غير كافٍ |
للحصول على تعريفات الأخطاء الشاملة الكاملة، انظر مرجع رموز الأخطاء.