توثيق API تنسيق الحدائق#
URL الأساسي:
https://api.ideal.house
الإصدار: v1
آخر تحديث: 2026-05-21
📖 نظرة عامة#
يحسّن API لتخطيط الحدائق أو يعيد تصميم مناطق المناظر الطبيعية الخارجية من صورة المصدر. يدعم الإرشاد النصي الاختياري، وخيارات نمط الحديقة، وعناصر المناظر الطبيعية، ووضع النماذج.
سير العمل غير متزامن:
- إنشاء مهمة — أرسل
imageUrlوالمعلمات الاختيارية، ثم احصل علىtaskId. - الاستعلام عن النتائج — استخدم
taskIdللاستعلام عن حالة المهمة والصورة المُنشأة.
🔐 المصادقة#
| الرأس | القيمة |
|---|---|
APIKEY | your_api_key_here |
💰 خصم الرصيد#
[!WARNING] تُخصم الأرصدة عند إنشاء المهمة بنجاح. إذا فشلت المهمة في النهاية، تُعاد الأرصدة المخصومة تلقائيًا.
سيعيد نقص الرصيد رمز الخطأ9051. اطّلِع على مرجع خصم الرصيد.
النموذج (modelType) | الرصيد المخصوم |
|---|---|
Flash | 1 رصيد |
Base | 3 رصيد |
Pro | 10 رصيد |
إذا لم يتم توفير modelType، فسيتم استخدام Base افتراضيًا.
🎨 خيارات النمط#
يدعم هذا API معاملات نمط اختيارية تُعاد من نقطة نهاية إعدادات نمط API.
الاستخدام:
GET /api/v1/style/landscaping/getStyles
| مجموعة النمط | حقل الطلب | الوصف |
|---|---|---|
gardenStyle | sceneId | خيار نمط الحديقة أو المناظر الطبيعية |
elements | sceneElementId | خيار عنصر المناظر الطبيعية. يدعم عدة معرفات خيارات مفصولة بفاصلة، مثل id1,id2 |
يحتوي كل خيار على name وid وurl. مرر id الخيار إلى حقل الطلب المقابل.
📌 نقاط نهاية API#
1. إنشاء مهمة تنسيق حدائق#
نقطة النهاية
POST /api/v1/landscaping/generate
رؤوس الطلب
| الرأس | مطلوب | الوصف |
|---|---|---|
APIKEY | ✅ نعم | مفتاح مصادقة API الخاص بك |
Content-Type | ✅ نعم | application/json |
جسم الطلب
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
imageUrl | string | ✅ نعم | URL صورة المصدر للمناظر الطبيعية |
prompt | string | ❌ اختياري | إرشاد نصي للنتيجة المطلوبة |
sceneId | string | ❌ اختياري | معرف نمط الحديقة من خيارات gardenStyle |
sceneElementId | string | ❌ اختياري | معرف عنصر المناظر الطبيعية من خيارات elements. يدعم عدة معرفات مفصولة بفاصلة، مثل id1,id2 |
modelType | string | ❌ اختياري | تعداد: Flash، 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/landscaping/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/backyard.jpg",
"prompt": "lush modern garden with clean stone paths",
"sceneId": "Landscape Design_Landscape Style_Mid-Century Modern Pool",
"sceneElementId": "Landscape Design_Scene Elements_Natural Elements_Flower,Landscape Design_Scene Elements_Natural Elements_Ground Cover",
"modelType": "Base"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class LandscapingApiExample {
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/backyard.jpg",
"prompt": "lush modern garden with clean stone paths",
"sceneId": "Landscape Design_Landscape Style_Mid-Century Modern Pool",
"sceneElementId": "Landscape Design_Scene Elements_Natural Elements_Flower,Landscape Design_Scene Elements_Natural Elements_Ground Cover",
"modelType": "Base"
}
""";
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/landscaping/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/backyard.jpg",
"prompt": "lush modern garden with clean stone paths",
"sceneId": "Landscape Design_Landscape Style_Mid-Century Modern Pool",
"sceneElementId": "Landscape Design_Scene Elements_Natural Elements_Flower,Landscape Design_Scene Elements_Natural Elements_Ground Cover",
"modelType": "Base"
}
response = requests.post(
f"{BASE_URL}/api/v1/landscaping/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 createLandscapingTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/landscaping/generate`,
{
imageUrl: 'https://example.com/backyard.jpg',
prompt: 'lush modern garden with clean stone paths',
sceneId: 'Landscape Design_Landscape Style_Mid-Century Modern Pool',
sceneElementId: 'Landscape Design_Scene Elements_Natural Elements_Flower,Landscape Design_Scene Elements_Natural Elements_Ground Cover',
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);
}
}
createLandscapingTask();
📤 الاستجابة#
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
2. استرداد نتيجة المهمة#
نقطة النهاية
GET /api/v1/landscaping/result
رؤوس الطلب
| الرأس | مطلوب | الوصف |
|---|---|---|
APIKEY | ✅ نعم | مفتاح مصادقة API الخاص بك |
معاملات الاستعلام
| المعامل | النوع | مطلوب | الوصف |
|---|---|---|---|
taskId | long | ✅ نعم | معرف المهمة الذي تم إعادته من نقطة النهاية للإنشاء |
📥 أمثلة الطلب#
cURL
curl -X GET "https://api.ideal.house/api/v1/landscaping/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class LandscapingResultExample {
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/landscaping/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/landscaping/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 pollLandscapingResult(taskId) {
const headers = { APIKEY: API_KEY };
while (true) {
const response = await axios.get(
`${BASE_URL}/api/v1/landscaping/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));
}
}
pollLandscapingResult(1234567890123456789n);
📤 مثال الاستجابة#
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/backyard.jpg",
"prompt": "lush modern garden with clean stone paths",
"sceneId": "Landscape Design_Landscape Style_Mid-Century Modern Pool",
"sceneElementId": "Landscape Design_Scene Elements_Natural Elements_Flower,Landscape Design_Scene Elements_Natural Elements_Ground Cover",
"modelType": "Base"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/landscaping_result.jpg",
"width": 1024,
"height": 1024
}
}
}
استجابة (معالجة المهمة / في الطابور)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 45,
"input": {
"imageUrl": "https://example.com/backyard.jpg",
"modelType": "Base"
},
"output": null
}
}
استجابة (فشل المهمة)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/backyard.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 | رصيد غير كافٍ |
للمزيد من تعريفات الأخطاء الشائعة، راجع مرجع رموز الخطأ.