Dokumentacja API wirtualnego przymierzania mebli#
Podstawowy URL:
https://api.ideal.house
Wersja: v1
Zaktualizowano: 2026-03-09
📖 Przegląd#
API wirtualnego przymierzania mebli umożliwia wirtualne umieszczenie elementów mebli w scenie pokoju za pomocą AI. Podajesz obraz pokoju oraz listę elementów mebli (każdy z obrazem i identyfikatorem produktu), a AI bezszwowo komponuje meble w scenie. Praca jest asynchroniczna i obejmuje dwa kroki:
- Utwórz zadanie — Prześlij obraz pomieszczenia i listę mebli, a następnie otrzymasz
taskId. - Sprawdzaj wyniki — Użyj
taskId, aby zapytać o status zadania i pobrać wygenerowany obraz.
📌 Uwaga: Obecnie obsługiwany jest tylko tryb
creative.
🔐 Uwierzytelnianie#
Wszystkie żądania API muszą być uwierzytelniane za pomocą klucza API Key.
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] 🪙 Kredyty są pobierane na podstawie wybranego
modelTypepo pomyślnym utworzeniu zadania. Jeśli zadanie ostatecznie zawiedzie, pobrane kredyty zostaną automatycznie zwrócone na Twoje konto.
Niewystarczająca liczba kredytów spowoduje zwrócenie kodu błędu9051. 📄 Zobacz Odniesienie do odejmowania kredytów.
Model (modelType) | Odejmowane kredyty |
|---|---|
Base | 3 kredyty |
Pro | 10 kredyty |
📌 API Punkty końcowe#
1. Utwórz zadanie wirtualnego przymierzania mebli#
Tworzy nowe zadanie AI wirtualnego przymierzania mebli i zwraca unikalny taskId do cyklicznego sprawdzania statusu.
Punkt końcowy
POST /api/v1/furnitureTryOn/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 obrazu sceny pomieszczenia, do którego zostaną umieszczone meble |
furnitureList | array | ✅ Tak | Lista elementów meblowych do umieszczenia w scenie. Maksymalnie 6 elementów. Zobacz Obiekt elementu meblowego |
prompt | string | ❌ Opcjonalnie | Własny prompt tekstowy, który dodatkowo kieruje umieszczeniem i stylizacją |
modelType | string | ❌ Opcjonalnie | Typ jakości modelu. Enum: Base, Pro. Domyślnie Base |
🛋️ Obiekt elementu meblowego#
Każdy element w furnitureList musi być obiektem z następującymi polami:
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
imageUrl | string | ✅ Tak | URL obrazu produktu meblowego (zalecane tło przezroczyste lub czyste) |
⚠️
furnitureListmoże zawierać maksymalnie 6 elementów.
🖼️ Wymagania dotyczące obrazów: Obraz pomieszczenia i każdy obraz mebla muszą używać 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 pikseli są automatycznie skalowane proporcjonalnie, aby zmieścić się w 6,000 × 6,000 px przed przetwarzaniem. Adresy URL muszą być bezpośrednio dostępne dla serwera API.
Przykład
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
},
{
"imageUrl": "https://example.com/table.png"
}
]
Typy modeli
| Wartość | Opis |
|---|---|
Base | Domyślny. Zbalansowana prędkość i jakość |
Pro | Wyższa jakość wyjścia, wolniejsze przetwarzanie |
📥 Przykłady żądań#
cURL
# Basic request (Base model)
curl -X POST "https://api.ideal.house/api/v1/furnitureTryOn/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
},
{
"imageUrl": "https://example.com/coffee-table.png"
}
],
"prompt": "modern minimalist style"
}'
# Pro model
curl -X POST "https://api.ideal.house/api/v1/furnitureTryOn/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
}
],
"prompt": "Scandinavian interior with warm lighting",
"modelType": "Pro"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class FurnitureTryOnApiExample {
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/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
},
{
"imageUrl": "https://example.com/coffee-table.png"
}
],
"prompt": "modern minimalist style",
"modelType": "Base"
}
""";
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/furnitureTryOn/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/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
},
{
"imageUrl": "https://example.com/coffee-table.png"
}
],
"prompt": "modern minimalist style",
"modelType": "Base"
}
# Pro model example:
# payload = {
# "imageUrl": "https://example.com/living-room.jpg",
# "furnitureList": [
# {
# "imageUrl": "https://example.com/sofa.png"
# }
# ],
# "prompt": "Scandinavian interior with warm lighting",
# "modelType": "Pro"
# }
response = requests.post(
f"{BASE_URL}/api/v1/furnitureTryOn/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 createFurnitureTryOnTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/furnitureTryOn/generate`,
{
imageUrl: 'https://example.com/living-room.jpg',
furnitureList: [
{
imageUrl: 'https://example.com/sofa.png'
},
{
imageUrl: 'https://example.com/coffee-table.png'
}
],
prompt: 'modern minimalist style',
modelType: 'Base'
// Pro model:
// modelType: 'Pro'
},
{
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);
}
}
createFurnitureTryOnTask();
📤 Odpowiedź#
Odpowiedź sukcesu
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Pole | Typ | Opis |
|---|---|---|
code | integer | 0 wskazuje 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 wirtualnego przymierzania mebli.
Punkt końcowy
GET /api/v1/furnitureTryOn/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/furnitureTryOn/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class FurnitureTryOnResultExample {
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/furnitureTryOn/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/furnitureTryOn/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":
output = result["output"]
print("Result URL:", output["resultUrl"])
print("Matched Items:", output.get("items", []))
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/furnitureTryOn/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('Matched Items:', result.output.items);
} else {
console.log('Task ended with status:', status);
}
break;
}
// Wait 3 seconds before next poll
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/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
},
{
"imageUrl": "https://example.com/coffee-table.png"
}
],
"prompt": "modern minimalist style",
"modelType": "Base"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/furniture_try_on_result.jpg",
"width": 1024,
"height": 1024
}
}
}
Odpowiedź (Zadanie w trakcie / W kolejce)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 45,
"input": {
"imageUrl": "https://example.com/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
}
],
"prompt": "modern minimalist style",
"modelType": "Base"
},
"output": null
}
}
Odpowiedź (Zadanie nie powiodło się)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
}
],
"modelType": "Base"
},
"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 Tobą w kolejce (0 oznacza, że zadanie jest obecnie przetwarzane) |
percentage | integer | Procent ukończenia zadania (0–100) |
input | object | Oryginalne parametry wejściowe zadania |
input.imageUrl | string | Adres URL obrazu sceny pomieszczenia |
input.furnitureList | array | Lista przesłanych elementów meblowych (maks. 6 elementów) |
input.furnitureList[].imageUrl | string | Adres URL obrazu produktu meblowego |
input.prompt | string | Własny prompt tekstowy (jeśli podano) |
input.modelType | string | Użyty typ modelu |
output | object | Wynik generowania (dostępny tylko, gdy status wynosi Success) |
output.resultUrl | string | Adres URL do wygenerowanego obrazu pomieszczenia z umieszczonymi meblami |
output.width | integer | Szerokość wyjściowa w pikselach |
output.height | integer | Wysokość wyjściowa w pikselach |
📊 Status zadania#
| Status | Opis |
|---|---|
Unprocessed | Zadanie zostało utworzone, ale nie zostało jeszcze rozpoczęte |
Processing | Zadanie jest obecnie przetwarzane |
Success | Zadanie zakończyło się pomyślnie — wynik jest dostępny |
Failed | Zadanie nie powiodło się z powodu błędu |
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 o błędzie |
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 — np. np., brak imageUrl lub furnitureList, lub furnitureList przekracza 6 elementów | Upewnij się, że zarówno imageUrl, jak i furnitureList są podane, niepuste i zawierają nie więcej niż 6 elementów |
5002 | API_KEY_INVALID | Nieprawidłowy lub brakujący klucz API | Upewnij się, że nagłówek APIKEY jest obecny i wartość jest poprawna |
9010 | SCAN_TEXT_ERROR | Prompt tekstowy nie przeszedł weryfikacji treści | Zmodyfikuj prompt, aby usunąć wszelką wrażliwą lub zakazaną treść |
9038 | PROHIBITED_CONTENT | Wygenerowany obraz wyjściowy zawiera zakazane treści | Dostosuj prompt/styl/wejścia i ponów |
9051 | COINS_NOT_ENOUGH | Niewystarczające monety / kredyty | Doładuj kredyty na swoim koncie i spróbuj ponownie |
📄 Pełną listę powszechnych kodów błędów API znajdziesz w Referencji kodów błędów.