オブジェクト削除 API ドキュメント#
ベース URL:
https://api.ideal.house
バージョン: v1
更新日: 2026-03-06
📖 概要#
オブジェクト削除 API は、AI を使って室内画像から不要な物や家具を取り除きます。次の二つのモードに対応しています。
single_furniture— 対象領域を示すマスク画像を指定して、特定の家具を削除します。AI が削除領域を適切に補完し、すっきりと自然な結果に仕上げます。whole_house— マスクを指定せずに、部屋全体からすべての家具を自動で削除します。
処理は非同期で、次の二つの手順で行います。
- タスクを作成する — 元画像、マスク、パラメーターを送信し、
taskIdを受け取ります。 - 結果をポーリングする —
taskIdでタスクの状態を照会し、結果画像を取得します。
🔐 認証#
すべての API リクエストは API キー で認証する必要があります。
リクエストヘッダーに API キーを含めます。
| ヘッダー | 値 |
|---|---|
APIKEY | your_api_key_here |
⚠️ API キーは安全に保管してください。 クライアント側のコードや公開リポジトリに公開しないでください。
💰 クレジットの消費#
[!WARNING] 🪙 タスクが正常に作成されると、アカウントから タスクごとに 1 クレジット が差し引かれます。タスクが最終的に 失敗 した場合、差し引かれたクレジットはアカウントに 自動的に返還 されます。
クレジット不足の場合、エラーコード9051が返ります。📄 クレジット消費リファレンスを参照してください。
🖼️ マスク画像の形式#
マスク画像は、元画像から削除する領域を指定します。
マスクの規則:
| 色 | 意味 |
|---|---|
| ⬛ 黒 | 削除 する領域(消去する物や範囲) |
| ⬜ 白 | 保持 する領域(残す背景) |
⚠️ マスク画像は、元画像(
imageUrl)と 同じ寸法 である必要があります。
マスクの例:
マスクの黒い領域は削除する家具を示し、白い領域は保持する背景を示します。
📌 API エンドポイント#
1. オブジェクト削除タスクの作成#
AI による新しいオブジェクト削除タスクを作成し、ポーリング用の一意の taskId を返します。
エンドポイント
POST /api/v1/objectRemover/generate
リクエストヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
APIKEY | ✅ はい | API の認証キー |
Content-Type | ✅ はい | application/json |
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
imageUrl | string | ✅ はい | 元画像の URL |
emptyType | string | ✅ はい | 削除モード。列挙値: whole_house、single_furniture。AI による削除領域の補完方法を制御します |
maskUrl | string | ⚠️ emptyType=single_furniture の場合に必須 | マスク画像の URL。黒い領域を削除し、白い領域は保持します。single_furniture モードでのみ有効 |
maskBase64 | string | ⚠️ emptyType=single_furniture の場合に必須 | Base64 エンコードしたマスク画像(PNG 形式を推奨)。maskUrl の代わりに指定できます。single_furniture モードでのみ有効 |
⚠️ モードごとのマスク要件:
single_furniture—maskUrlまたはmaskBase64の少なくとも一つが 必須 です。両方を指定した場合はmaskUrlが優先されます。whole_house— マスクのフィールドは 無視 されます。AI が部屋全体からすべての家具を自動で削除します。
🖼️ 画像の要件: 元画像とマスクは JPG/JPEG、PNG、WebP のいずれかを使用する必要があります。各画像は 20 MB 以下で、寸法は 128 × 128 px 以上 6,000 × 6,000 px 以下です。最大ピクセル寸法を超える画像は、処理前に 6,000 × 6,000 px 以内に収まるよう縦横比を保って自動縮小されます。画像の URLs は API サーバーから直接アクセスできる必要があります。Base64 マスクにもデコード後の画像に同じ制限が適用され、data-URL プレフィックスを含めてはいけません。
削除方式の選択肢
| 値 | マスク必須 | 説明 |
|---|---|---|
single_furniture | ✅ はい | マスクで指定した特定の家具を削除し、その領域を自然に補完します |
whole_house | ❌ いいえ | 部屋全体からすべての家具を自動で削除します。マスクは不要です |
📥 リクエスト例#
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();
📤 レスポンス#
成功時のレスポンス
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| フィールド | 型 | 説明 |
|---|---|---|
code | integer | 0 は成功を示します |
message | string | レスポンスのメッセージ |
data | long | 結果をポーリングするための一意のタスク ID |
2. タスク結果の取得#
作成済みのオブジェクト削除タスクの現在の状態と出力を取得します。
エンドポイント
GET /api/v1/objectRemover/result
リクエストヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
APIKEY | ✅ はい | API の認証キー |
クエリパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
taskId | long | ✅ はい | タスク作成エンドポイントから返されたタスク ID |
📥 リクエスト例#
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);
📤 レスポンス#
成功時のレスポンス(タスク完了)
{
"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
}
}
}
レスポンス(タスク処理中または待機中)
{
"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
}
}
レスポンス(タスク失敗)
{
"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
}
}
レスポンスのフィールド
| フィールド | 型 | 説明 |
|---|---|---|
id | long | タスクの一意の識別子 |
status | string | 現在のタスクの状態(タスクの状態を参照) |
waitNumber | integer | キュー内で前に並んでいるタスクの数(0 は現在処理中であることを示します) |
percentage | integer | タスクの完了率(0–100) |
input | object | タスクに指定した元の入力パラメーター |
input.imageUrl | string | 元画像の URL |
input.maskUrl | string | マスク画像の URL(maskUrl で指定した場合) |
input.emptyType | string | 使用した削除モード(single_furniture または whole_house) |
output | object | 生成結果(status が Success の場合のみ利用可能) |
output.resultUrl | string | オブジェクトを削除した結果画像の URL |
output.width | integer | 出力の幅(ピクセル単位) |
output.height | integer | 出力の高さ(ピクセル単位) |
📊 タスクの状態#
| 状態 | 説明 |
|---|---|
Unprocessed | タスクは作成済みですが、まだ開始していません |
Processing | タスクは現在処理中です |
Success | タスクが正常に完了し、出力を利用できます |
Failed | エラーによりタスクが失敗しました |
3-5 秒 ごとにポーリングしてください。API タスク制限を参照してください。
❌ エラーレスポンス#
すべてのエラーレスポンスは同じ JSON 構造を使用します。
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
エラーコードリファレンス#
| コード | 名前 | 説明 | 推奨される対応 |
|---|---|---|---|
1001 | FAILED | リクエストの失敗(一般的なエラー) | message フィールドで具体的なエラー内容を確認する |
1003 | INTERNAL_ERROR | サーバー内部のエラー | 少し待って再試行し、解消しない場合はサポートに連絡する |
1011 | PARAM_ERROR | リクエストパラメーターのエラー(e.g. maskUrl と maskBase64 の両方が未指定) | マスクのフィールドが少なくとも一つ指定されていることを確認する |
5002 | API_KEY_INVALID | API キーが無効または未指定 | APIKEY ヘッダーが存在し、その値が正しいことを確認する |
9038 | PROHIBITED_CONTENT | 生成された出力画像に禁止された内容が含まれています | プロンプト、スタイル、入力を調整して再試行する |
9051 | COINS_NOT_ENOUGH | コインまたはクレジットの不足 | アカウントにクレジットを追加して再試行する |
📄 共通の API エラーコードの全一覧は、エラーコードリファレンスを参照してください。
