Dokumentacja Object Remover API#
Podstawowy URL:
https://api.ideal.house
Wersja: v1
Zaktualizowano: 2026-03-06
📖 Przegląd#
Object Remover API umożliwia usuwanie niechcianych przedmiotów lub mebli z obrazów wnętrz za pomocą AI. Obsługuje dwa tryby:
single_furniture— Usuwanie konkretnego mebla poprzez podanie obrazu maski, który oznacza docelowy obszar. AI inteligentnie wypełni usunięty obszar, tworząc czysty, naturalnie wyglądający rezultat.whole_house— Automatyczne usuwanie wszystkich mebli z całego pokoju bez konieczności podawania maski.
Praca jest asynchroniczna i obejmuje dwa kroki:
- Utworzenie zadania — Prześlij swój obraz źródłowy, maskę i parametry, a następnie otrzymaj
taskId. - Cykliczne sprawdzanie wyników — Użyj
taskId, aby zapytać o status zadania i pobrać obraz wyniku.
🔐 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 |
⚠️ Zabezpiecz swój klucz API. Nie ujawniaj go w kodzie po stronie klienta ani w publicznych repozytoriach.
💰 Odejmowanie kredytów#
[!WARNING] 🪙 Każde zadanie pobiera 1 kredyt z Twojego konta po pomyślnym utworzeniu zadania. Jeśli zadanie ostatecznie zawiedzie, pobrane kredyty zostaną automatycznie zwrócone na Twoje konto.
Niewystarczające kredyty zwrócą kod błędu9051. 📄 Zobacz Referencja odejmowania kredytów.
🖼️ Format obrazu maski#
Obraz maski definiuje obszar, który ma zostać usunięty z obrazu źródłowego.
Zasady maski:
| Kolor | Znaczenie |
|---|---|
| ⬛ Czarny | Obszar do usunięcia (przedmiot / region do wymazania) |
| ⬜ Biały | Obszar do zachowania (tło do utrzymania) |
⚠️ Obraz maski musi mieć te same wymiary co obraz źródłowy (
imageUrl).
Przykład maski:
Czarny obszar na masce oznacza meble do usunięcia; biały obszar to tło, które należy zachować.
📌 Końcówki API#
1. Utworzenie zadania Object Remover#
Tworzy nowe zadanie AI usuwania obiektów i zwraca unikalny taskId do cyklicznego sprawdzania.
Końcówka
POST /api/v1/objectRemover/generate
Nagłówki żądania
| Nagłówek | Wymagany | Opis |
|---|---|---|
APIKEY | ✅ Tak | Twój klucz uwierzytelniający API |
Content-Type | ✅ Tak | application/json |
Ciało żądania
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
imageUrl | string | ✅ Tak | Adres URL obrazu źródłowego |
emptyType | string | ✅ Tak | Tryb usuwania. Wyliczenie: whole_house, single_furniture. Kontroluje sposób wypełniania przez AI usuniętego obszaru |
maskUrl | string | ⚠️ Wymagane, gdy emptyType=single_furniture | Adres URL obrazu maski. Obszary czarne zostaną usunięte; obszary białe zostaną zachowane. Ma znaczenie tylko w trybie single_furniture |
maskBase64 | string | ⚠️ Wymagane, gdy emptyType=single_furniture | Obraz maski zakodowany w Base64 (zalecany format PNG). Alternatywa dla maskUrl. Ma znaczenie tylko w trybie single_furniture |
⚠️ Wymagania dotyczące maski w zależności od trybu:
single_furniture— Należy podać co najmniej jedno z:maskUrllubmaskBase64. Wymagane. Jeśli podano oba,maskUrlma pierwszeństwo.whole_house— Pola maski są ignorowane. AI automatycznie usuwa wszystkie meble z całego pokoju.
🖼️ Wymagania dotyczące obrazów: Obraz źródłowy i maska 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 obrazów muszą być bezpośrednio dostępne dla serwera API. Maska w formacie Base64 podlega tym samym limitom rozmiaru po dekodowaniu i nie może zawierać prefiksu data-URL.
Opcje typu Empty
| Wartość | Wymagana maska | Opis |
|---|---|---|
single_furniture | ✅ Tak | Usuwa konkretny mebel zdefiniowany przez maskę i naturalnie wypełnia obszar |
whole_house | ❌ Nie | Automatycznie usuwa wszystkie meble z całego pokoju — nie wymaga maski |
📥 Przykłady żądań#
cURL
# single_furniture mode — mask required (using maskUrl)
curl -X POST "https://api.ideal.house/api/v1/objectRemover/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"emptyType": "single_furniture",
"maskUrl": "https://example.com/mask.png"
}'
# single_furniture mode — mask required (using maskBase64)
curl -X POST "https://api.ideal.house/api/v1/objectRemover/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"emptyType": "single_furniture",
"maskBase64": "iVBORw0KGgoAAAANSUhEUgAA..."
}'
# whole_house mode — no mask needed
curl -X POST "https://api.ideal.house/api/v1/objectRemover/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"emptyType": "whole_house"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Base64;
public class ObjectRemoverApiExample {
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",
"maskUrl": "https://example.com/mask.png",
"emptyType": "single_furniture"
}
""";
// 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",
// "maskBase64": "%s",
// "emptyType": "single_furniture"
// }
// """.formatted(maskBase64);
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/objectRemover/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",
"maskUrl": "https://example.com/mask.png",
"emptyType": "single_furniture"
}
# 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",
# "maskBase64": mask_base64,
# "emptyType": "single_furniture"
# }
response = requests.post(
f"{BASE_URL}/api/v1/objectRemover/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 createObjectRemoverTask() {
try {
// Option 1: Use maskUrl
const payload = {
imageUrl: 'https://example.com/room.jpg',
maskUrl: 'https://example.com/mask.png',
emptyType: 'single_furniture'
};
// 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',
// maskBase64: maskBase64,
// emptyType: 'single_furniture'
// };
const response = await axios.post(
`${BASE_URL}/api/v1/objectRemover/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);
}
}
createObjectRemoverTask();
📤 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 usuwania obiektów.
Końcówka
GET /api/v1/objectRemover/result
Nagłówki żądania
| Nagłówek | Wymagany | Opis |
|---|---|---|
APIKEY | ✅ Tak | Twój klucz uwierzytelniający API |
Parametry zapytania
| Parametr | Typ | Wymagany | Opis |
|---|---|---|---|
taskId | long | ✅ Tak | identyfikator zadania zwrócony z końcówki tworzenia zadania |
📥 Przykłady żądań#
cURL
curl -X GET "https://api.ideal.house/api/v1/objectRemover/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class ObjectRemoverResultExample {
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/objectRemover/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/objectRemover/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/objectRemover/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);
📤 Odpowiedź#
Odpowiedź sukcesu (zadanie zakończone)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/room.jpg",
"maskUrl": "https://example.com/mask.png",
"emptyType": "single_furniture"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/object_remover_result.jpg",
"width": 1024,
"height": 1024
}
}
}
Odpowiedź (zadanie w trakcie przetwarzania / w kolejce)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 50,
"input": {
"imageUrl": "https://example.com/room.jpg",
"maskUrl": "https://example.com/mask.png",
"emptyType": "single_furniture"
},
"output": null
}
}
Odpowiedź (zadanie niepowodzenie)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"maskUrl": "https://example.com/mask.png",
"emptyType": "single_furniture"
},
"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 bieżące przetwarzanie) |
percentage | integer | procent ukończenia zadania (0–100) |
input | object | oryginalne parametry wejściowe zadania |
input.imageUrl | string | Adres URL obrazu źródłowego |
input.maskUrl | string | Adres URL obrazu maski (jeśli podano przez maskUrl) |
input.emptyType | string | Użyty tryb usuwania (single_furniture lub whole_house) |
output | object | wynik generowania (dostępny tylko, gdy status wynosi Success) |
output.resultUrl | string | Adres URL obrazu wyniku po usunięciu obiektów |
output.width | integer | szerokość wyjścia w pikselach |
output.height | integer | wysokość wyjścia 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 |
Cyklicznie sprawdzaj 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
}
Referencja kodów błędów#
| Kod | Nazwa | Opis | Sugerowane działanie |
|---|---|---|---|
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 | wewnętrzny błąd serwera | Ponów po krótkim opóźnieniu; skontaktuj się z pomocą techniczną, jeśli problem utrzymuje się |
1011 | PARAM_ERROR | Błąd parametru żądania — np., brak zarówno maskUrl, jak i maskBase64 | Upewnij się, że podano co najmniej jedno pole maski |
5002 | API_KEY_INVALID | nieprawidłowy lub brakujący klucz API | Upewnij się, że nagłówek APIKEY jest obecny i wartość jest poprawna |
9038 | PROHIBITED_CONTENT | wygenerowany obraz wyjściowy zawiera zakazaną treść | Dostosuj prompt/styl/wejścia i ponów |
9051 | COINS_NOT_ENOUGH | niewystarczające monety / kredyty | Doładuj kredyty na swoim koncie i ponów |
📄 Pełna lista powszechnych kodów błędów API znajduje się w Referencji kodów błędów.
