توثيق API الاستبدال الذكي#
URL الأساسي:
https://api.ideal.house
الإصدار: v1
آخر تحديث: 2026-03-06
📖 نظرة عامة#
تتيح لك API الاستبدال الذكي استبدال منطقة محددة في صورة بشكل ذكي بمحتوى تم إنشاؤه بالذكاء الاصطناعي بناءً على طلب نصي. توفر صورة المصدر، وصورة القناع التي تحدد المنطقة المراد استبدالها، وطلباً نصياً يصف ما يجب أن يملأ تلك المنطقة. سيقوم الذكاء الاصطناعي بدمج المحتوى المُولّد بسلاسة في الصورة الأصلية. سير العمل غير متزامن ويتكون من خطوتين:
- إنشاء مهمة — قدّم صورتك وقناعك وطلبك النصي، ثم احصل على
taskId. - استفسار عن النتائج دورياً — استخدم
taskIdلاستعلام حالة المهمة واسترجاع صورة النتيجة.
🔐 المصادقة#
يجب مصادقة جميع طلبات API باستخدام مفتاح API.
تضمّن مفتاح API في رأس الطلب:
| الرأس | القيمة |
|---|---|
APIKEY | your_api_key_here |
⚠️ احفظ مفتاح API بأمان. لا تعرضه في كود الواجهة الأمامية أو المستودعات العامة.
💰 خصم الرصيد#
[!WARNING] 🪙 تخصم كل مهمة 1 رصيد من حسابك عند إنشائها بنجاح. إذا فشلت المهمة في النهاية، تُعاد الأرصدة المخصومة إلى حسابك تلقائيًا.
سيعيد نقص الرصيد رمز الخطأ9051. 📄 اطّلِع على مرجع خصم الرصيد.
🖼️ تنسيق صورة القناع#
تحدد صورة القناع المنطقة المراد استبدالها في صورة المصدر.
قواعد القناع:
| اللون | المعنى |
|---|---|
| ⬛ أسود | منطقة الاستبدال (المنطقة التي سيتم فيها توليد محتوى جديد) |
| ⬜ أبيض | منطقة الحفظ (الخلفية لإبقائها دون تغيير) |
⚠️ يجب أن تتطابق أبعاد صورة القناع مع نفس أبعاد صورة المصدر (
imageUrl).
مثال على القناع:
يحدد المنطقة السوداء في القناع المنطقة المراد استبدالها بالذكاء الاصطناعي؛ بينما يمثل الأبيض الخلفية المراد حفظها.
📌 نقاط نهاية API#
1. إنشاء مهمة الاستبدال الذكي#
ينشئ مهمة جديدة للاستبدال الذكي بالذكاء الاصطناعي ويعيد taskId فريدًا للاستعلام الدوري عن النتائج.
نقطة النهاية
POST /api/v1/smartReplace/generate
رؤوس الطلب
| الرأس | مطلوب | الوصف |
|---|---|---|
APIKEY | ✅ نعم | مفتاح مصادقة API الخاص بك |
Content-Type | ✅ نعم | application/json |
جسم الطلب
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
imageUrl | string | ✅ مطلوب | URL صورة المصدر |
prompt | string | ✅ مطلوب | الطلب النصي الوصفي للمحتوى المراد توليده في منطقة القناع (مثلًا، "a modern armchair"، "marble flooring") |
maskUrl | string | ⚠️ إما maskUrl أو maskBase64 | URL صورة القناع. المناطق السوداء سيتم استبدالها؛ والمناطق البيضاء سيتم حفظها |
maskBase64 | string | ⚠️ إما maskUrl أو maskBase64 | صورة قناع مشفرة بـ Base64 (يوصى بتنسيق PNG). تُستخدم عندما لا يمكنك توفير URL مستضاف |
⚠️ يجب تقديم واحد على الأقل من
maskUrlأوmaskBase64. إذا تم تقديم كلاهما، فإنmaskUrlيأخذ الأولوية.
🖼️ متطلبات الصور: يجب أن تستخدم صورة المصدر والقناع JPG/JPEG أو PNG أو WebP. يجب ألا يزيد حجم كل صورة عن 20 ميجابايت، وأن تكون الأبعاد من 128 × 128 بكسل إلى 6,000 × 6,000 بكسل (ضمن النطاق). يتم تصغير الصور التي تتجاوز الحد الأقصى لأبعاد البكسل تلقائياً بنسب متساوية لتناسب 6,000 × 6,000 بكسل قبل المعالجة. يجب أن تكون URLs الصور قابلة للوصول مباشرة من قبل خادم الـ API. تخضع صورة القناع بـ Base64 لنفس حدود الصورة المفكوك ويجب ألا تتضمن بادئة data-URL.
📥 أمثلة الطلب#
cURL
# Using maskUrl
curl -X POST "https://api.ideal.house/api/v1/smartReplace/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"prompt": "a modern velvet sofa in dark blue",
"maskUrl": "https://example.com/mask.png"
}'
# Using maskBase64
curl -X POST "https://api.ideal.house/api/v1/smartReplace/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"prompt": "a modern velvet sofa in dark blue",
"maskBase64": "iVBORw0KGgoAAAANSUhEUgAA..."
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Base64;
public class SmartReplaceApiExample {
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();
// Option 1: Use maskUrl
String requestBody = """
{
"imageUrl": "https://example.com/room.jpg",
"prompt": "a modern velvet sofa in dark blue",
"maskUrl": "https://example.com/mask.png"
}
""";
// Option 2: Use maskBase64 (encode local mask file)
// byte[] maskBytes = Files.readAllBytes(Path.of("/path/to/mask.png"));
// String maskBase64 = Base64.getEncoder().encodeToString(maskBytes);
// String requestBody = """
// {
// "imageUrl": "https://example.com/room.jpg",
// "prompt": "a modern velvet sofa in dark blue",
// "maskBase64": "%s"
// }
// """.formatted(maskBase64);
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/smartReplace/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
import base64
BASE_URL = "https://api.ideal.house"
API_KEY = "your_api_key_here"
headers = {
"APIKEY": API_KEY,
"Content-Type": "application/json"
}
# Option 1: Use maskUrl
payload = {
"imageUrl": "https://example.com/room.jpg",
"prompt": "a modern velvet sofa in dark blue",
"maskUrl": "https://example.com/mask.png"
}
# Option 2: Use maskBase64 (encode local mask file)
# with open("/path/to/mask.png", "rb") as f:
# mask_base64 = base64.b64encode(f.read()).decode("utf-8")
# payload = {
# "imageUrl": "https://example.com/room.jpg",
# "prompt": "a modern velvet sofa in dark blue",
# "maskBase64": mask_base64
# }
response = requests.post(
f"{BASE_URL}/api/v1/smartReplace/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 fs = require('fs');
const BASE_URL = 'https://api.ideal.house';
const API_KEY = 'your_api_key_here';
async function createSmartReplaceTask() {
try {
// Option 1: Use maskUrl
const payload = {
imageUrl: 'https://example.com/room.jpg',
prompt: 'a modern velvet sofa in dark blue',
maskUrl: 'https://example.com/mask.png'
};
// Option 2: Use maskBase64 (encode local mask file)
// const maskBuffer = fs.readFileSync('/path/to/mask.png');
// const maskBase64 = maskBuffer.toString('base64');
// const payload = {
// imageUrl: 'https://example.com/room.jpg',
// prompt: 'a modern velvet sofa in dark blue',
// maskBase64: maskBase64
// };
const response = await axios.post(
`${BASE_URL}/api/v1/smartReplace/generate`,
payload,
{
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);
}
}
createSmartReplaceTask();
📤 الاستجابة#
استجابة النجاح
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| الحقل | النوع | الوصف |
|---|---|---|
code | integer | يشير 0 إلى النجاح |
message | string | رسالة الاستجابة |
data | long | معرف المهمة الفريد للاستعلام عن النتائج |
2. استرداد نتيجة المهمة#
يسترجع الحالة الحالية والمخرجات لمهمة الاستبدال الذكي تم إنشاؤها سابقاً.
نقطة النهاية
GET /api/v1/smartReplace/result
رؤوس الطلب
| الرأس | مطلوب | الوصف |
|---|---|---|
APIKEY | ✅ نعم | مفتاح مصادقة API الخاص بك |
معاملات الاستعلام
| المعامل | النوع | مطلوب | الوصف |
|---|---|---|---|
taskId | long | ✅ نعم | معرف المهمة الذي تمت إعادته من نقطة النهاية لإنشاء المهمة |
📥 أمثلة الطلب#
cURL
curl -X GET "https://api.ideal.house/api/v1/smartReplace/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class SmartReplaceResultExample {
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/smartReplace/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
# Poll until task is complete
while True:
response = requests.get(
f"{BASE_URL}/api/v1/smartReplace/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) # Poll every 3 seconds
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 pollResult(taskId) {
const headers = { 'APIKEY': API_KEY };
while (true) {
const response = await axios.get(
`${BASE_URL}/api/v1/smartReplace/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;
}
// Wait 3 seconds before next poll
await new Promise(resolve => setTimeout(resolve, 3000));
}
}
pollResult(1234567890123456789n);
📤 الاستجابة#
استجابة النجاح (اكتمال المهمة)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/room.jpg",
"prompt": "a modern velvet sofa in dark blue",
"maskUrl": "https://example.com/mask.png"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/smart_replace_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",
"prompt": "a modern velvet sofa in dark blue",
"maskUrl": "https://example.com/mask.png"
},
"output": null
}
}
استجابة (فشل المهمة)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"prompt": "a modern velvet sofa in dark blue",
"maskUrl": "https://example.com/mask.png"
},
"output": null
}
}
حقول الاستجابة
| الحقل | النوع | الوصف |
|---|---|---|
id | long | معرّف المهمة الفريد |
status | string | حالة المهمة الحالية (اطّلِع على حالة المهمة) |
waitNumber | integer | عدد المهام التي تسبق هذه المهمة في الطابور (يعني 0 المعالجة حاليًا) |
percentage | integer | نسبة اكتمال المهمة (0–100) |
input | object | معاملات الإدخال الأصلية للمهمة |
input.imageUrl | string | URL صورة المصدر |
input.prompt | string | الطلب النصي الوصفي لمحتوى الاستبدال |
input.maskUrl | string | URL صورة القناع (إذا تم تقديمها عبر maskUrl) |
output | object | نتيجة التوليد (متاحة فقط عندما يكون status هو Success) |
output.resultUrl | string | URL إلى صورة نتيجة الاستبدال الذكي |
output.width | integer | عرض الإخراج بالبكسل |
output.height | integer | ارتفاع الإخراج بالبكسل |
📊 حالة المهمة#
| الحالة | الوصف |
|---|---|
Unprocessed | تم إنشاء المهمة ولكن لم تبدأ بعد |
Processing | تتم معالجة المهمة حاليًا |
Success | اكتملت المهمة بنجاح — الإخراج متاح |
Failed | فشلت المهمة بسبب خطأ |
استعلم كل 3-5 ثوانٍ. اطّلِع على حد مهمات API.
❌ استجابات الخطأ#
تتشارك جميع استجابات الخطأ نفس هيكل JSON:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
مرجع رموز الخطأ#
| الرمز | الاسم | الوصف | الإجراء المقترح |
|---|---|---|---|
1001 | FAILED | فشل الطلب (خطأ عام) | تحقق من حقل message للحصول على تفاصيل الخطأ المحددة |
1003 | INTERNAL_ERROR | خطأ داخلي في الخادم | أعد المحاولة بعد فترة انتظار قصيرة; تواصل مع الدعم إذا استمر |
1011 | PARAM_ERROR | خطأ في معاملات الطلب — مثلًا، prompt أو القناع مفقود | تأكد من توفير كلٍ من prompt وحقل قناع واحد على الأقل |
5002 | API_KEY_INVALID | مفتاح API غير صالح أو مفقود | تأكد من وجود رأس APIKEY وأن القيمة صحيحة |
9010 | SCAN_TEXT_ERROR | فشل مراجعة محتوى مطالبة النص | عدّل المطالبة لإزالة أي محتوى حساس أو محظور |
9038 | PROHIBITED_CONTENT | تحتوي صورة الإخراج المُولَّدة على محتوى محظور | عدّل التوجيه النصي/النمط/الإدخالات وأعد المحاولة |
9051 | COINS_NOT_ENOUGH | رصيد / عملات غير كافية | قم بشحن رصيد حسابك وأعد المحاولة |
📄 للحصول على القائمة الكاملة لرموز خطأ API الشائعة، راجع مرجع رموز الخطأ.
