Documentation de l'API de suppression d'objets#
URL de base :
https://api.ideal.house
Version : v1
Mis à jour : 2026-03-06
📖 Vue d'ensemble#
L'API de suppression d'objets vous permet de supprimer les objets ou meubles indésirables des photos d'intérieur grâce à l'IA. Deux modes sont disponibles :
single_furniture— Supprime un meuble spécifique en fournissant une image de masquage qui indique la zone cible. L'IA remplit intelligemment la zone supprimée pour produire un résultat propre et naturel.whole_house— Supprime automatiquement tous les meubles de la pièce entière sans nécessiter de masque.
Le flux de travail est asynchrone et comporte deux étapes :
- Créer une tâche — Soumettez votre image source, votre masque et vos paramètres, puis recevez un
taskId. - Interrogation périodique des résultats — Utilisez le
taskIdpour interroger l'état de la tâche et récupérer l'image résultat.
🔐 Authentification#
Toutes les requêtes API doivent être authentifiées à l'aide d'une clé API.
Incluez votre clé API dans l'en-tête de la requête :
| En-tête | Valeur |
|---|---|
APIKEY | your_api_key_here |
⚠️ Conservez votre clé API en sécurité. Ne l'exposez pas dans du code côté client ou dans des dépôts publics.
💰 Déduction de crédits#
[!WARNING] 🪙 Chaque tâche déduit 1 crédit de votre compte lors de la création réussie de la tâche. Si la tâche échoue finalement, les crédits déduits vous seront remboursés automatiquement sur votre compte.
Un solde insuffisant retournera le code d'erreur9051. 📄 Consultez Référence de déduction des crédits.
🖼️ Format de l'image de masque#
L'image de masquage définit la zone à supprimer sur l'image source.
Règles du masque :
| Couleur | Signification |
|---|---|
| ⬛ Noir | Zone à supprimer (objet / région à effacer) |
| ⬜ Blanc | Zone à conserver (arrière-plan à garder) |
⚠️ L'image de masque doit correspondre aux mêmes dimensions que l'image source (
imageUrl).
Exemple de masque :
La zone noire du masque indique le meuble à supprimer ; la zone blanche correspond à l'arrière-plan à conserver.
📌 Points de terminaison de l'API#
1. Créer une tâche de suppression d'objets#
Crée une nouvelle tâche de suppression d'objets par IA et renvoie un taskId unique pour interrogation périodique.
Point de terminaison
POST /api/v1/objectRemover/generate
En-têtes de la requête
| En-tête | Requis | Description |
|---|---|---|
APIKEY | ✅ Oui | Votre clé d'authentification API |
Content-Type | ✅ Oui | application/json |
Corps de la requête
| Champ | Type | Requis | Description |
|---|---|---|---|
imageUrl | string | ✅ Requis | URL de l'image source |
emptyType | string | ✅ Requis | Mode de suppression. Enum : whole_house, single_furniture. Contrôle la façon dont l'IA remplit la zone supprimée |
maskUrl | string | ⚠️ Requis lorsque emptyType=single_furniture | URL de l'image de masquage. Les zones noires seront supprimées ; les zones blanches seront conservées. N'a d'effet qu'en mode single_furniture |
maskBase64 | string | ⚠️ Requis lorsque emptyType=single_furniture | Image de masquage encodée en Base64 (format PNG recommandé). Alternative à maskUrl. N'a d'effet qu'en mode single_furniture |
⚠️ Exigence de masque selon le mode :
single_furniture— Au moins l'un des champsmaskUrloumaskBase64doit être fourni. Si les deux sont présents,maskUrlest prioritaire.whole_house— Les champs de masque sont ignorés. L'IA supprime automatiquement tous les meubles de la pièce entière.
🖼️ Exigences image : L'image source et le masque doivent utiliser les formats JPG/JPEG, PNG ou WebP. Chaque image ne doit pas dépasser 20 Mo, avec des dimensions comprises entre 128 × 128 px et 6,000 × 6,000 px (inclus). Les images dont les dimensions pixel dépassent le maximum sont automatiquement redimensionnées proportionnellement pour tenir dans 6,000 × 6,000 px avant le traitement. Les URLs d'image doivent être directement accessibles par le serveur de l'API. Un masque Base64 est soumis aux mêmes limites d'image décodée et ne doit pas inclure de préfixe data-URL.
Options du mode de suppression
| Valeur | Masque requis | Description |
|---|---|---|
single_furniture | ✅ Oui | Supprime un meuble spécifique défini par le masque et remplit la zone de manière naturelle |
whole_house | ❌ Non | Supprime automatiquement tous les meubles de la pièce entière — aucun masque requis |
📥 Exemples de requête#
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();
📤 Réponse#
Réponse de succès
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Champ | Type | Description |
|---|---|---|
code | integer | 0 indique le succès |
message | string | Message de réponse |
data | long | L'ID unique de la tâche pour l'interrogation périodique des résultats |
2. Obtenir le résultat de la tâche#
Récupère le statut actuel et le résultat d'une tâche de suppression d'objets précédemment créée.
Point de terminaison
GET /api/v1/objectRemover/result
En-têtes de la requête
| En-tête | Requis | Description |
|---|---|---|
APIKEY | ✅ Oui | Votre clé d'authentification API |
Paramètres de requête
| Paramètre | Type | Requis | Description |
|---|---|---|---|
taskId | long | ✅ Oui | L'ID de tâche renvoyé par le point de terminaison de création |
📥 Exemples de requête#
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);
📤 Réponse#
Réponse de succès (tâche terminée)
{
"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
}
}
}
Réponse (tâche en cours de traitement / en file d'attente)
{
"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
}
}
Réponse (tâche échouée)
{
"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
}
}
Champs de la réponse
| Champ | Type | Description |
|---|---|---|
id | long | Identifiant unique de la tâche |
status | string | État actuel de la tâche (voir État de la tâche) |
waitNumber | integer | Nombre de tâches qui précèdent cette tâche dans la file d’attente (0 signifie actuellement en cours de traitement) |
percentage | integer | Pourcentage d'avancement de la tâche (0–100) |
input | object | Les paramètres d'entrée originaux de la tâche |
input.imageUrl | string | URL de l'image source |
input.maskUrl | string | URL de l'image de masque (si fournie via maskUrl) |
input.emptyType | string | Mode de suppression utilisé (single_furniture ou whole_house) |
output | object | Résultat de la génération (disponible uniquement lorsque status est Success) |
output.resultUrl | string | URL vers l'image résultat sans l'objet supprimé |
output.width | integer | Largeur de sortie en pixels |
output.height | integer | Hauteur de sortie en pixels |
📊 État de la tâche#
| État | Description |
|---|---|
Unprocessed | La tâche a été créée mais n'a pas encore démarré |
Processing | La tâche est actuellement en cours de traitement |
Success | Tâche terminée avec succès — la sortie est disponible |
Failed | La tâche a échoué en raison d'une erreur |
Effectuez une interrogation périodique toutes les 3-5 secondes. Consultez Limite de tâches API.
❌ Réponses d'erreur#
Toutes les réponses d'erreur partagent la même structure JSON :
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
Référence des codes d'erreur#
| Code | Nom | Description | Action recommandée |
|---|---|---|---|
1001 | FAILED | Échec de la requête (erreur générique) | Consultez le champ message pour les détails spécifiques de l'erreur |
1003 | INTERNAL_ERROR | Erreur interne du serveur | Réessayez après un bref délai ; contactez le support si le problème persiste |
1011 | PARAM_ERROR | Erreur de paramètre de requête — par exemple, les deux champs maskUrl et maskBase64 sont absents | Assurez-vous de fournir au moins un champ de masque |
5002 | API_KEY_INVALID | Clé API invalide ou manquante | Assurez-vous que l'en-tête APIKEY est présent et que la valeur est correcte |
9038 | PROHIBITED_CONTENT | L'image de sortie générée contient du contenu interdit | Ajustez l'invite/le style/les entrées et réessayez |
9051 | COINS_NOT_ENOUGH | Crédits / pièces insuffisants | Alimentez vos crédits de compte et réessayez |
📄 Pour la liste complète des codes d'erreur courants de l'API, reportez-vous à la Référence des codes d'erreur.
