AI 3D Render API Belgelendirmesi#
Temel URL:
https://api.ideal.house
Sürüm: v1
Güncellendi: 2026-03-06
📖 Genel Bakış#
AI 3D Render API, kaynak görüntüye dayalı bir 3D render görevi göndermenizi; render derecesi, render modu, isteğe bağlı metin istemi ve referans stil görüntüleri üzerinde ince ayar kontrolü sağlamanızı mümkün kılar. İş akışı asenkron olup iki adımdan oluşur:
- Görev oluşturma — Girdi parametrelerinizi gönderin ve bir
taskIdalın. - Sonuçları sorgulama — Görev durumunu sorgulamak ve üretilen çıktıyı almak için
taskIdkullanın.
🔐 Kimlik Doğrulama#
Tüm API istekleri, bir API Anahtarı kullanılarak kimlik doğrulanmalıdır.
İstek başlığına API Anahtarınızı ekleyin:
| Başlık | Değer |
|---|---|
APIKEY | your_api_key_here |
⚠️ API Anahtarınızı güvenli tutun. İstemci tarafı kodda veya herkese açık depolarda ifşa etmeyin.
💰 Kredi Kesintisi#
[!WARNING] 🪙 Krediler, görev başarıyla oluşturulduğunda seçilen
modelTypetemelinde düşülür. Görev nihayetinde başarısız olursa, düşülen krediler hesabınıza otomatik olarak iade edilir.
Yetersiz krediler9051hata kodunu döndürür. 📄 Kredi Kesintisi Referansı bölümüne bakın.
Model (modelType) | Kesilen Kredi |
|---|---|
Flash | 1 kredi |
Base | 3 kredi |
Pro | 10 kredi |
📌 API Uç Noktaları#
1. 3D Render Görevi Oluşturma#
Yeni bir AI 3D render görevi oluşturur ve sorgulama için benzersiz bir taskId döndürür.
Uç nokta
POST /api/v1/ai3dRendering/generate
İstek Başlıkları
| Başlık | Zorunlu | Açıklama |
|---|---|---|
APIKEY | ✅ Evet | API kimlik doğrulama anahtarınız |
Content-Type | ✅ Evet | application/json |
İstek Gövdesi
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
imageUrl | string | ✅ Evet | Render edilecek kaynak görüntünün URL |
prompt | string | ❌ İsteğe bağlı | Render stili veya içeriğini yönlendirmek için ek metin istemi |
modelType | string | ❌ İsteğe bağlı | Model kalite türü. Sayısal: Flash, Base, Pro. Varsayılan: Flash |
renderDegree | integer | ❌ İsteğe bağlı | Render yoğunluk seviyesi. Aralık: 1 (en hafif) – 6 (en güçlü). Varsayılan: 3. Yalnızca modelType Flash olduğunda etkilidir |
renderMode | string | ❌ İsteğe bağlı | Render modu. Sayısal: default, creativeMode. Varsayılan: default |
refImageUrl | string | ❌ İsteğe bağlı | Render çıktısını yönlendirmek için referans stil görüntüsünün URL |
⚠️ Not:
renderDegreeyalnızcamodelTypeFlasholarak ayarlandığında etkilidir.modelTypebelirtilmezse, varsayılan olarakFlashkullanılır.
🖼️ Görsel gereksinimleri: Tüm girdi ve referans görseller JPG/JPEG, PNG veya WebP formatında olmalıdır. Her görsel en fazla 20 MB boyutunda olabilir; boyutları 128 × 128 px ile 6,000 × 6,000 px (dahil) arasında olmalıdır. Maksimum piksel boyutlarını aşan görseller, işleme başlamadan önce 6,000 × 6,000 px sınırlarına sığacak şekilde orantılı olarak otomatik olarak küçültülür. Görsel URLs, API sunucusu tarafından doğrudan erişilebilir olmalıdır.
Model Türleri
| Değer | Açıklama |
|---|---|
Flash | Varsayılan. En hızlı üretim hızı, standart kalite. renderDegree kontrolünü destekler |
Base | Hız ve kalite dengesi. renderDegree yok sayılır |
Pro | En yüksek kalite, daha yavaş üretim. renderDegree yok sayılır |
Render Modları
| Değer | Açıklama |
|---|---|
default | Varsayılan mod. Render sırasında orijinal görüntü dokusunu ve yapısını korur (Dokuyu Koruma Modu) |
creativeMode | Yaratıcı mod — daha sanatsal ve stilize render dönüşümleri uygular |
Render Derecesi
| Değer | Açıklama |
|---|---|
1 | En hafif render — minimal dönüşüm |
2 – 5 | Kademeli render yoğunluğu |
6 | En güçlü render — maksimum dönüşüm |
📥 İstek Örnekleri#
cURL
# Using Flash model with renderDegree (texture preservation mode)
curl -X POST "https://api.ideal.house/api/v1/ai3dRendering/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
}'
# Using Flash model with creative mode, prompt and a reference image
curl -X POST "https://api.ideal.house/api/v1/ai3dRendering/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"prompt": "A modern minimalist living room with wooden floor",
"modelType": "Flash",
"renderDegree": 5,
"renderMode": "creativeMode",
"refImageUrl": "https://example.com/style-reference.jpg"
}'
# Using Pro model (renderDegree is ignored)
curl -X POST "https://api.ideal.house/api/v1/ai3dRendering/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"modelType": "Pro",
"renderMode": "default"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class Ai3dRenderingApiExample {
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();
// Flash model with renderDegree (renderDegree only works with Flash)
String requestBody = """
{
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
}
""";
// Pro model example (renderDegree is ignored)
// String requestBody = """
// {
// "imageUrl": "https://example.com/room.jpg",
// "modelType": "Pro",
// "renderMode": "default"
// }
// """;
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/ai3dRendering/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"
}
# Flash model — renderDegree takes effect (default texture preservation mode)
payload = {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
}
# Flash model with creative mode, prompt and reference image
# payload = {
# "imageUrl": "https://example.com/room.jpg",
# "prompt": "A modern minimalist living room with wooden floor",
# "modelType": "Flash",
# "renderDegree": 5,
# "renderMode": "creativeMode",
# "refImageUrl": "https://example.com/style-reference.jpg"
# }
# Pro model — renderDegree is ignored
# payload = {
# "imageUrl": "https://example.com/room.jpg",
# "modelType": "Pro",
# "renderMode": "default"
# }
response = requests.post(
f"{BASE_URL}/api/v1/ai3dRendering/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 createRenderingTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/ai3dRendering/generate`,
{
// Flash model — renderDegree takes effect
imageUrl: 'https://example.com/room.jpg',
modelType: 'Flash',
renderDegree: 4,
renderMode: 'default'
// Flash model with creative mode:
// prompt: 'A modern minimalist living room with wooden floor',
// modelType: 'Flash',
// renderDegree: 5,
// renderMode: 'creativeMode',
// refImageUrl: 'https://example.com/style-reference.jpg'
// Pro model — renderDegree is ignored:
// imageUrl: 'https://example.com/room.jpg',
// modelType: 'Pro',
// renderMode: 'default'
},
{
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);
}
}
createRenderingTask();
📤 Yanıt#
Başarılı Yanıt
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Alan | Tür | Açıklama |
|---|---|---|
code | integer | 0 başarıyı gösterir |
message | string | Yanıt mesajı |
data | long | Sonuçları sorgulamak için benzersiz görev kimliği |
2. Görev Sonucunu Al#
Daha önce oluşturulmuş bir render görevinin mevcut durumunu ve çıktısını alır.
Uç nokta
GET /api/v1/ai3dRendering/result
İstek Başlıkları
| Başlık | Zorunlu | Açıklama |
|---|---|---|
APIKEY | ✅ Evet | API kimlik doğrulama anahtarınız |
Sorgu Parametreleri
| Parametre | Tür | Zorunlu | Açıklama |
|---|---|---|---|
taskId | long | ✅ Evet | Görev oluşturma uç noktasından döndürülen görev kimliği |
📥 İstek Örnekleri#
cURL
curl -X GET "https://api.ideal.house/api/v1/ai3dRendering/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class Ai3dRenderingResultExample {
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/ai3dRendering/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/ai3dRendering/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/ai3dRendering/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);
} else {
console.log('Task ended with status:', status);
}
break;
}
// Wait 3 seconds before next poll
await new Promise(resolve => setTimeout(resolve, 3000));
}
}
pollResult(1234567890123456789n);
📤 Yanıt#
Başarılı Yanıt (Görev Tamamlandı)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/rendered_result.jpg",
"width": 1024,
"height": 1024
}
}
}
Yanıt (Görev İşleniyor / Sırada)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 50,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
},
"output": null
}
}
Yanıt (Görev Başarısız)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
},
"output": null
}
}
Yanıt Alanları
| Alan | Tür | Açıklama |
|---|---|---|
id | long | Görev benzersiz tanımlayıcısı |
status | string | Mevcut görev durumu (Görev Durumu bölümüne bakın) |
waitNumber | integer | Kuyrukta öndeki görev sayısı (0 şu anda işleniyor demektir) |
percentage | integer | Görev tamamlanma yüzdesi (0–100) |
input | object | Görevin orijinal girdi parametreleri |
input.imageUrl | string | Kaynak görüntü URL (verildiyse) |
input.prompt | string | Kaynak metin istemi (verildiyse) |
input.modelType | string | Kullanılan model türü |
input.renderDegree | integer | Kullanılan render yoğunluk seviyesi (1–6) |
input.renderMode | string | Kullanılan render modu (default veya creativeMode) |
input.refImageUrl | string | Referans stil görüntüsü URL (verildiyse) |
output | object | Üretim sonucu (yalnızca status Success olduğunda kullanılabilir) |
output.resultUrl | string | Render edilen çıktı görüntüsüne URL |
output.width | integer | Piksel cinsinden çıktı genişliği |
output.height | integer | Piksel cinsinden çıktı yüksekliği |
📊 Görev Durumu#
| Durum | Açıklama |
|---|---|
Unprocessed | Görev oluşturuldu ancak henüz başlamadı |
Processing | Görev şu anda işleniyor |
Success | Görev başarıyla tamamlandı — çıktı kullanılabilir |
Failed | Görev bir hata nedeniyle başarısız oldu |
Her 3-5 saniyede sorgulayın. API Görev Sınırı bölümüne bakın.
❌ Hata Yanıtları#
Tüm hata yanıtları aynı JSON yapısını paylaşır:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
Hata Kodu Referansı#
| Kod | Ad | Açıklama | Önerilen Eylem |
|---|---|---|---|
1001 | FAILED | İstek başarısız oldu (genel hata) | Ayrıntılı hata bilgileri için message alanını kontrol edin |
1003 | INTERNAL_ERROR | Dahili sunucu hatası | Kısa bir gecikme sonrası yeniden deneyin; devam ederse destek ekibiyle iletişime geçin |
1011 | PARAM_ERROR | İstek parametre hatası | Tüm zorunlu parametrelerin sağlandığını ve doğru biçimlendirildiğini doğrulayın |
5002 | API_KEY_INVALID | Geçersiz veya eksik API Anahtarı | APIKEY başlığının mevcut olduğundan ve değerinin doğru olduğundan emin olun |
9010 | SCAN_TEXT_ERROR | Metin ifadesi içerik incelemesinden geçemedi | Hassas veya yasaklı içeriği kaldırmak için ifadeyi değiştirin |
9038 | PROHIBITED_CONTENT | Üretilen çıktı görüntüsü yasaklı içerik barındırıyor | İfadeyi/stili/girdileri ayarlayın ve yeniden deneyin |
9051 | COINS_NOT_ENOUGH | Yetersiz jeton / kredi | Hesap kredilerinizi yükleyin ve yeniden deneyin |
📄 Yaygın API hata kodlarının tam listesi için Hata Kodu Referansı bölümüne başvurun.