Ideal House
コンテンツにスキップ

スマート置換 API ドキュメント#

ベース URL: https://api.ideal.house
バージョン: v1
更新日: 2026-03-06


📖 概要#

スマート置換 API は、画像内の選択した領域を、テキストプロンプトに基づいて AI が生成した内容に置き換えます。元画像、置き換える領域を指定する マスク画像、その領域を何で埋めるかを説明するテキストプロンプトを提供します。AI が生成内容を元画像に自然になじませます。処理は非同期で、次の二つの手順で行います。

  1. タスクを作成する — 画像、マスク、プロンプトを送信し、taskId を受け取ります。
  2. 結果をポーリングするtaskId でタスクの状態を照会し、結果画像を取得します。

🔐 認証#

すべての API リクエストは API キー で認証する必要があります。

リクエストヘッダーに API キーを含めます。

ヘッダー
APIKEYyour_api_key_here

⚠️ API キーは安全に保管してください。 クライアント側のコードや公開リポジトリに公開しないでください。


💰 クレジットの消費#

[!WARNING] 🪙 タスクが正常に作成されると、アカウントから タスクごとに 1 クレジット が差し引かれます。タスクが最終的に 失敗 した場合、差し引かれたクレジットはアカウントに 自動的に返還 されます。
クレジット不足の場合、エラーコード 9051 が返ります。📄 クレジット消費リファレンスを参照してください。


🖼️ マスク画像の形式#

マスク画像は、元画像で 置き換える 領域を指定します。

マスクの規則:

意味
置き換える 領域(新しい内容を生成する範囲)
保持 する領域(変更せずに残す背景)

⚠️ マスク画像は、元画像(imageUrl)と 同じ寸法 である必要があります。

マスクの例:

マスクの例

マスクの黒い領域は AI が置き換える範囲を示し、白い領域は保持する背景を示します。


📌 API エンドポイント#


1. スマート置換タスクの作成#

AI による新しいスマート置換タスクを作成し、ポーリング用の一意の taskId を返します。

エンドポイント

プレーンテキスト
POST /api/v1/smartReplace/generate

リクエストヘッダー

ヘッダー必須説明
APIKEY✅ はいAPI の認証キー
Content-Type✅ はいapplication/json

リクエストボディ

フィールド必須説明
imageUrlstring✅ はい元画像の URL
promptstring✅ はいマスク領域に生成する内容を説明するテキストプロンプト(e.g. "a modern armchair""marble flooring"
maskUrlstring⚠️ maskUrl または maskBase64 のいずれかマスク画像の URL。黒い領域を置き換え、白い領域は保持します
maskBase64string⚠️ maskUrl または maskBase64 のいずれかBase64 エンコードしたマスク画像(PNG 形式を推奨)。ホストされた URL を提供できない場合に使用します

⚠️ maskUrl または maskBase64 の少なくとも一つを指定する必要があります。 両方を指定した場合は maskUrl が優先されます。

🖼️ 画像の要件: 元画像とマスクは JPG/JPEG、PNG、WebP のいずれかを使用する必要があります。各画像は 20 MB 以下で、寸法は 128 × 128 px 以上 6,000 × 6,000 px 以下です。最大ピクセル寸法を超える画像は、処理前に 6,000 × 6,000 px 以内に収まるよう縦横比を保って自動縮小されます。画像の URLs は API サーバーから直接アクセスできる必要があります。Base64 マスクにもデコード後の画像に同じ制限が適用され、data-URL プレフィックスを含めてはいけません。


📥 リクエスト例#

cURL
bash
# Using maskUrl
curl -X POST "https://api.ideal.house/api/v1/smartReplace/generate" \
  -H "APIKEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "imageUrl": "https://example.com/room.jpg",
    "prompt": "a modern velvet sofa in dark blue",
    "maskUrl": "https://example.com/mask.png"
  }'

# Using maskBase64
curl -X POST "https://api.ideal.house/api/v1/smartReplace/generate" \
  -H "APIKEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "imageUrl": "https://example.com/room.jpg",
    "prompt": "a modern velvet sofa in dark blue",
    "maskBase64": "iVBORw0KGgoAAAANSUhEUgAA..."
  }'
Java (OkHttp)
java
import okhttp3.*;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Base64;

public class SmartReplaceApiExample {

    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",
                "prompt": "a modern velvet sofa in dark blue",
                "maskUrl": "https://example.com/mask.png"
            }
            """;

        // 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",
        //         "prompt": "a modern velvet sofa in dark blue",
        //         "maskBase64": "%s"
        //     }
        //     """.formatted(maskBase64);

        Request request = new Request.Builder()
            .url(BASE_URL + "/api/v1/smartReplace/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)
python
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",
    "prompt": "a modern velvet sofa in dark blue",
    "maskUrl": "https://example.com/mask.png"
}

# 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",
#     "prompt": "a modern velvet sofa in dark blue",
#     "maskBase64": mask_base64
# }

response = requests.post(
    f"{BASE_URL}/api/v1/smartReplace/generate",
    headers=headers,
    json=payload
)

data = response.json()
task_id = data.get("data")
print(f"Task ID: {task_id}")
Node.js (axios)
javascript
const axios = require('axios');
const fs = require('fs');

const BASE_URL = 'https://api.ideal.house';
const API_KEY  = 'your_api_key_here';

async function createSmartReplaceTask() {
  try {
    // Option 1: Use maskUrl
    const payload = {
      imageUrl: 'https://example.com/room.jpg',
      prompt: 'a modern velvet sofa in dark blue',
      maskUrl: 'https://example.com/mask.png'
    };

    // 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',
    //   prompt: 'a modern velvet sofa in dark blue',
    //   maskBase64: maskBase64
    // };

    const response = await axios.post(
      `${BASE_URL}/api/v1/smartReplace/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);
  }
}

createSmartReplaceTask();

📤 レスポンス#

成功時のレスポンス

json
{
  "code": 0,
  "message": "success",
  "data": 1234567890123456789
}
フィールド説明
codeinteger0 は成功を示します
messagestringレスポンスのメッセージ
datalong結果をポーリングするための一意のタスク ID

2. タスク結果の取得#

作成済みのスマート置換タスクの現在の状態と出力を取得します。

エンドポイント

プレーンテキスト
GET /api/v1/smartReplace/result

リクエストヘッダー

ヘッダー必須説明
APIKEY✅ はいAPI の認証キー

クエリパラメーター

パラメーター必須説明
taskIdlong✅ はいタスク作成エンドポイントから返されたタスク ID

📥 リクエスト例#

cURL
bash
curl -X GET "https://api.ideal.house/api/v1/smartReplace/result?taskId=1234567890123456789" \
  -H "APIKEY: your_api_key_here"
Java (OkHttp)
java
import okhttp3.*;
import java.io.IOException;

public class SmartReplaceResultExample {

    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/smartReplace/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)
python
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/smartReplace/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)
javascript
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/smartReplace/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);

📤 レスポンス#

成功時のレスポンス(タスク完了)

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Success",
    "waitNumber": 0,
    "percentage": 100,
    "input": {
      "imageUrl": "https://example.com/room.jpg",
      "prompt": "a modern velvet sofa in dark blue",
      "maskUrl": "https://example.com/mask.png"
    },
    "output": {
      "resultUrl": "https://cdn.ideal.house/output/smart_replace_result.jpg",
      "width": 1024,
      "height": 1024
    }
  }
}

レスポンス(タスク処理中または待機中)

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Processing",
    "waitNumber": 1,
    "percentage": 45,
    "input": {
      "imageUrl": "https://example.com/room.jpg",
      "prompt": "a modern velvet sofa in dark blue",
      "maskUrl": "https://example.com/mask.png"
    },
    "output": null
  }
}

レスポンス(タスク失敗)

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Failed",
    "waitNumber": 0,
    "percentage": 0,
    "input": {
      "imageUrl": "https://example.com/room.jpg",
      "prompt": "a modern velvet sofa in dark blue",
      "maskUrl": "https://example.com/mask.png"
    },
    "output": null
  }
}

レスポンスのフィールド

フィールド説明
idlongタスクの一意の識別子
statusstring現在のタスクの状態(タスクの状態を参照)
waitNumberintegerキュー内で前に並んでいるタスクの数(0 は現在処理中であることを示します)
percentageintegerタスクの完了率(0–100
inputobjectタスクに指定した元の入力パラメーター
input.imageUrlstring元画像の URL
input.promptstring置き換える内容を説明するテキストプロンプト
input.maskUrlstringマスク画像の URL(maskUrl で指定した場合)
outputobject生成結果(statusSuccess の場合のみ利用可能)
output.resultUrlstringスマート置換の結果画像の URL
output.widthinteger出力の幅(ピクセル単位)
output.heightinteger出力の高さ(ピクセル単位)

📊 タスクの状態#

状態説明
Unprocessedタスクは作成済みですが、まだ開始していません
Processingタスクは現在処理中です
Successタスクが正常に完了し、出力を利用できます
Failedエラーによりタスクが失敗しました

3-5 秒 ごとにポーリングしてください。API タスク制限を参照してください。


❌ エラーレスポンス#

すべてのエラーレスポンスは同じ JSON 構造を使用します。

json
{
  "code": 5002,
  "message": "Invalid API Key",
  "data": null
}

エラーコードリファレンス#

コード名前説明推奨される対応
1001FAILEDリクエストの失敗(一般的なエラー)message フィールドで具体的なエラー内容を確認する
1003INTERNAL_ERRORサーバー内部のエラー少し待って再試行し、解消しない場合はサポートに連絡する
1011PARAM_ERRORリクエストパラメーターのエラー(e.g. prompt またはマスクが未指定)prompt と、少なくとも一つのマスクのフィールドが指定されていることを確認する
5002API_KEY_INVALIDAPI キーが無効または未指定APIKEY ヘッダーが存在し、その値が正しいことを確認する
9010SCAN_TEXT_ERRORテキストプロンプトがコンテンツ審査に通りませんでしたプロンプトを修正し、機微な内容や禁止された内容を除く
9038PROHIBITED_CONTENT生成された出力画像に禁止された内容が含まれていますプロンプト、スタイル、入力を調整して再試行する
9051COINS_NOT_ENOUGHコインまたはクレジットの不足アカウントにクレジットを追加して再試行する

📄 共通の API エラーコードの全一覧は、エラーコードリファレンスを参照してください。