Dokumentacja Virtual Staging API#
Podstawowy URL:
https://api.ideal.house
Wersja: v1
Zaktualizowano: 2026-04-13
📖 Przegląd#
Virtual Staging API umożliwia projektowanie pustego lub częściowo umeblowanego pokoju za pomocą AI.
Przesyłasz adres URL obrazu pokoju oraz opcjonalny tekstowy opis, a następnie pobierasz wygenerowany wynik asynchronicznie.
- Utworzenie zadania — Prześlij
imageUrli opcjonalnyprompt, a następnie otrzymasztaskId. - Cykliczne sprawdzanie wyników — Użyj
taskId, aby sprawdzić status zadania i pobrać obraz wyjściowy.
🔐 Uwierzytelnianie#
Wszystkie żądania API muszą być uwierzytelniane za pomocą klucza API.
Włącz swój klucz API w nagłówku żądania:
| Nagłówek | Wartość |
|---|---|
APIKEY | your_api_key_here |
⚠️ Utrzymuj swój klucz API w poufności. Nie ujawniaj go w kodzie klienckim ani w publicznych repozytoriach.
💰 Odejmowanie kredytów#
[!WARNING] 🪙 1 kredyt jest odejmowany, gdy zadanie zostanie pomyślnie utworzone.
Jeśli zadanie ostatecznie zawiedzie, odejmowany kredyt zostanie automatycznie zwrócony.
Niewystarczająca liczba kredytów spowoduje zwrócenie kodu błędu9051. 📄 Zobacz Odniesienie do odejmowania kredytów.
| Operacja | Odejmowane kredyty |
|---|---|
| Zadanie Virtual Staging | 1 kredyt |
📌 API Punkty końcowe#
1. Utworzenie zadania Virtual Staging#
Tworzy nowe zadanie virtual staging i zwraca unikalny taskId do cyklicznego sprawdzania.
Punkt końcowy
POST /api/v1/virtualStaging/generate
Nagłówki żądania
| Nagłówek | Wymagane | Opis |
|---|---|---|
APIKEY | ✅ Tak | Twój klucz uwierzytelniający API |
Content-Type | ✅ Tak | application/json |
Ciało żądania
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
imageUrl | string | ✅ Tak | URL źródłowego obrazu pokoju |
prompt | string | ❌ Nie | Opcjonalny prompt kierujący stylem i umeblowaniem |
indoorTypeId | string | ❌ Nie | Opcjonalny preset typu pokoju. Zobacz Opcje typów wnętrz |
indoorStyleId | string | ❌ Nie | Opcjonalny preset stylu wnętrza. Zobacz Opcje stylów wnętrz |
indoorElemId | string | ❌ Nie | Opcjonalny preset elementów pokoju. Obsługuje wiele ID połączonych przecinkiem, na przykład id1,id2 |
🖼️ Wymagania dotyczące obrazów: Użyj formatu JPG/JPEG, PNG lub WebP. Każdy obraz nie może być większy niż 20 MB, a jego wymiary muszą mieścić się w przedziale od 128 × 128 px do 6,000 × 6,000 px (włącznie). Obrazy przekraczające maksymalne wymiary w pikselach są automatycznie skalowane proporcjonalnie tak, aby mieściły się w granicach 6,000 × 6,000 px przed rozpoczęciem przetwarzania. Adres URL obrazu musi być bezpośrednio dostępny dla serwera API.
🎨 Opcje stylów#
indoorTypeId, indoorStyleId i indoorElemId można wybrać z punktu końcowego Konfiguracja stylów API.
Użyj:
GET /api/v1/style/virtual_staging/getStyles
| Grupa stylów | Pole żądania | Opis |
|---|---|---|
roomType | indoorTypeId | Opcja typu pokoju |
style | indoorStyleId | Opcja stylu wnętrza |
elements | indoorElemId | Opcja elementów pokoju. Obsługuje wiele ID opcji połączonych przecinkiem, na przykład id1,id2 |
Każda opcja zawiera name, id i url. Przekazuj id opcji do odpowiedniego pola żądania.
📥 Przykłady żądań#
cURL
curl -X POST "https://api.ideal.house/api/v1/virtualStaging/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/empty-living-room.jpg",
"prompt": "Warm and modern living room styling",
"indoorTypeId": "Interior Design_Interior Scene_Living Room",
"indoorStyleId": "Interior_Interior Style_Popular_Vs_Modern Farmhouse",
"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 VirtualStagingApiExample {
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/empty-bedroom.jpg",
"prompt": "Cozy contemporary bedroom",
"indoorTypeId": "Interior Design_Interior Scene_Bed Room",
"indoorStyleId": "Interior_Interior Style_Popular_Vs_Contemporary Warm",
"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/virtualStaging/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/empty-home-office.jpg",
"prompt": "Minimal modern home office",
"indoorTypeId": "Interior Design_Interior Scene_Home Office",
"indoorStyleId": "Interior_Interior Style_Popular_Vs_Modern Minimal",
"indoorElemId": "Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table"
}
response = requests.post(
f"{BASE_URL}/api/v1/virtualStaging/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 createVirtualStagingTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/virtualStaging/generate`,
{
imageUrl: 'https://example.com/empty-dining-room.jpg',
prompt: 'Modern luxury dining room',
indoorTypeId: 'Interior Design_Interior Scene_Dining Room',
indoorStyleId: 'Interior_Interior Style_Popular_Vs_Modern Luxury',
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);
}
}
createVirtualStagingTask();
📤 Odpowiedź#
Odpowiedź sukcesu
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Pole | Typ | Opis |
|---|---|---|
code | integer | 0 oznacza sukces |
message | string | Komunikat odpowiedzi |
data | long | Unikalny identyfikator zadania do cyklicznego sprawdzania wyników |
2. Pobranie wyniku zadania#
Pobiera bieżący status i wynik wcześniej utworzonego zadania virtual staging.
Punkt końcowy
GET /api/v1/virtualStaging/result
Nagłówki żądania
| Nagłówek | Wymagane | Opis |
|---|---|---|
APIKEY | ✅ Tak | Twój klucz uwierzytelniający API |
Parametry zapytania
| Parametr | Typ | Wymagane | Opis |
|---|---|---|---|
taskId | long | ✅ Tak | Identyfikator zadania zwrócony z punktu końcowego tworzenia zadania |
📥 Przykłady żądań#
cURL
curl -X GET "https://api.ideal.house/api/v1/virtualStaging/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class VirtualStagingResultExample {
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/virtualStaging/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/virtualStaging/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":
output = result["output"]
print("Result URL:", output["resultUrl"])
print("Size:", output["width"], "x", output["height"])
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/virtualStaging/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));
}
}
pollResult(1234567890123456789n);
📤 Odpowiedź#
Odpowiedź sukcesu (Zadanie zakończone)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/empty-room.jpg",
"prompt": "modern country living room with warm neutral materials",
"indoorTypeId": "Interior Design_Interior Scene_Living Room",
"indoorStyleId": "Interior_Interior Style_Popular_Vs_Modern Farmhouse",
"indoorElemId": "Interior Design_Scene Elements_Living Room_Shelving,Interior Design_Scene Elements_Living Room_Coffee Table"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/virtual_staging_result.jpg",
"width": 1024,
"height": 1024
}
}
}
Odpowiedź (Zadanie w trakcie / W kolejce)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 46,
"input": {
"imageUrl": "https://example.com/empty-room.jpg",
"prompt": "coastal bedroom with soft light and natural textures",
"indoorTypeId": "Interior Design_Interior Scene_Bed Room",
"indoorStyleId": "Interior_Interior Style_Popular_Vs_Contemporary Warm"
},
"output": null
}
}
Odpowiedź (Zadanie nie powiodło się)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/empty-room.jpg",
"prompt": "..."
},
"output": null
}
}
Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
id | long | Unikalny identyfikator zadania |
status | string | Bieżący status zadania (zobacz Status zadania) |
waitNumber | integer | Liczba zadań przed obecnym w kolejce (0 oznacza przetwarzanie w toku) |
percentage | integer | Procent ukończenia zadania (0-100) |
errorReason | string | Powód niepowodzenia, gdy status wynosi Failed |
input | object | Oryginalne parametry wejściowe przesłane dla tego zadania |
input.imageUrl | string | Adres URL obrazu źródłowego pokoju |
input.prompt | string | Prompt użytkownika (jeśli podano) |
input.indoorTypeId | string | Użyty preset typu pokoju (jeśli podano) |
input.indoorStyleId | string | Użyty preset stylu wnętrza (jeśli podano) |
input.indoorElemId | string | Użyty preset elementów pokoju (jeśli podano). Może zawierać wiele ID połączonych przecinkiem |
output | object | Wynik generowania (dostępny tylko, gdy status wynosi Success) |
output.resultUrl | string | Adres URL wygenerowanego obrazu wyniku wirtualnego wystroju |
output.width | integer | Szerokość obrazu wyjściowego w pikselach |
output.height | integer | Wysokość obrazu wyjściowego w pikselach |
📊 Status zadania#
| Status | Znaczenie |
|---|---|
Unprocessed | Zadanie zostało utworzone i czeka w kolejce |
Processing | Zadanie jest obecnie w trakcie |
Success | Zadanie zakończono pomyślnie |
Failed | Zadanie nie powiodło się i nie wygenerowano wyniku |
Wykonuj cykliczne sprawdzanie co 3-5 sekund. Zobacz Limit zadań API.
❌ Odpowiedzi błędów#
Wszystkie odpowiedzi błędów mają tę samą strukturę JSON:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
Odniesienie do kodów błędów#
| Kod | Nazwa | Opis | Zalecana czynność |
|---|---|---|---|
1001 | FAILED | Żądanie nie powiodło się (błąd ogólny) | Sprawdź pole message, aby uzyskać szczegółowe informacje |
1003 | INTERNAL_ERROR | Błąd wewnętrzny serwera | Ponów po krótkim opóźnieniu; skontaktuj się z pomocą techniczną, jeśli problem trwa |
1011 | PARAM_ERROR | Błąd parametru żądania (na przykład brak imageUrl) | Upewnij się, że imageUrl jest podany i jest prawidłowym adresem URL |
5002 | API_KEY_INVALID | Nieprawidłowy lub brakujący klucz API | Upewnij się, że nagłówek APIKEY jest obecny i poprawny |
9010 | SCAN_TEXT_ERROR | Prompt nie przeszedł moderacji treści | Zmień prompt, aby usunąć wrażliwe lub zakazane treści |
9038 | PROHIBITED_CONTENT | Wygenerowany obraz wyjściowy zawiera zakazane treści | Dostosuj prompt/styl/wejścia i ponów |
9051 | COINS_NOT_ENOUGH | Niewystarczająca liczba kredytów | Doładuj kredyty i ponów |
📄 Pełne definicje wspólnych błędów znajdziesz w Odniesieniu do kodów błędów.