テクスチャ置換 API ドキュメント#
ベース URL:
https://api.ideal.house
バージョン: v1
更新日: 2026-03-25
📖 概要#
テクスチャ置換 API は、スタイルの参照画像を使って、画像内で選択した領域のテクスチャや素材を 置き換えます。元画像と、適用するテクスチャや素材を指定する スタイル参照画像、および 新しいテクスチャを適用する領域を指定する マスク画像 を提供します。AI が新しいテクスチャを 元のシーンに自然になじませます。処理は非同期で、次の二つの手順で行います。
- タスクを作成する — 元画像、スタイル画像、マスク、パラメーターを送信し、
taskIdを受け取ります。 - 結果をポーリングする —
taskIdでタスクの状態を照会し、結果画像を取得します。
🔐 認証#
すべての API リクエストは API キー で認証する必要があります。
リクエストヘッダーに API キーを含めます。
| ヘッダー | 値 |
|---|---|
APIKEY | your_api_key_here |
⚠️ API キーは安全に保管してください。 クライアント側のコードや公開リポジトリに公開しないでください。
💰 クレジットの消費#
[!WARNING] 🪙 タスクが正常に作成されると 3 クレジット が差し引かれます。タスクが最終的に 失敗 した場合、差し引かれたクレジットはアカウントに 自動的に返還 されます。
クレジット不足の場合、エラーコード9051が返ります。📄 クレジット消費リファレンスを参照してください。
| 操作 | 消費クレジット |
|---|---|
| テクスチャ置換タスク | 3 クレジット |
🖼️ マスク画像の形式#
マスク画像は、テクスチャを置き換える領域を指定します。
マスクの規則:
| 色 | 意味 |
|---|---|
| ⬛ 黒 | 新しいテクスチャ を適用する領域(置き換える領域) |
| ⬜ 白 | 保持 する領域(変更せずに残す背景) |
⚠️ マスク画像は、元画像(
imageUrl)と 同じ寸法 である必要があります。
マスクの例:
マスクの黒い領域は新しいテクスチャを適用する場所を指定し、白い領域は 保持する背景を指定します。
📌 API エンドポイント#
1. テクスチャ置換タスクの作成#
AI による新しいテクスチャ置換タスクを作成し、ポーリング用の一意の taskId を返します。
エンドポイント
POST /api/v1/textureReplacer/generate
リクエストヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
APIKEY | ✅ はい | API の認証キー |
Content-Type | ✅ はい | application/json |
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
imageUrl | string | ✅ はい | 元画像の URL(テクスチャを適用する部屋またはシーン) |
styleImageUrl | string | ✅ はい | 適用するテクスチャまたは素材を指定するスタイル参照画像の URL |
maskUrl | string | ⚠️ maskUrl または maskBase64 のいずれか | マスク画像の URL。黒い領域に新しいテクスチャを適用し、白い領域は保持します |
maskBase64 | string | ⚠️ maskUrl または maskBase64 のいずれか | Base64 エンコードしたマスク画像(PNG 形式を推奨)。ホストされた URL を提供できない場合に使用します |
prompt | string | ❌ 任意 | テクスチャ生成をさらに指定する追加のテキストプロンプト |
⚠️
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
# Using maskUrl
curl -X POST "https://api.ideal.house/api/v1/textureReplacer/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"styleImageUrl": "https://example.com/marble-texture.jpg",
"maskUrl": "https://example.com/mask.png"
}'
# Using maskBase64 with optional prompt
curl -X POST "https://api.ideal.house/api/v1/textureReplacer/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"styleImageUrl": "https://example.com/wood-texture.jpg",
"maskBase64": "iVBORw0KGgoAAAANSUhEUgAA...",
"prompt": "natural oak wood grain texture"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Base64;
public class TextureReplacerApiExample {
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",
"styleImageUrl": "https://example.com/marble-texture.jpg",
"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",
// "styleImageUrl": "https://example.com/marble-texture.jpg",
// "maskBase64": "%s",
// "prompt": "natural oak wood grain texture"
// }
// """.formatted(maskBase64);
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/textureReplacer/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",
"styleImageUrl": "https://example.com/marble-texture.jpg",
"maskUrl": "https://example.com/mask.png"
}
# Option 2: Use maskBase64 with optional prompt
# 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",
# "styleImageUrl": "https://example.com/wood-texture.jpg",
# "maskBase64": mask_base64,
# "prompt": "natural oak wood grain texture"
# }
response = requests.post(
f"{BASE_URL}/api/v1/textureReplacer/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 createTextureReplacerTask() {
try {
// Option 1: Use maskUrl
const payload = {
imageUrl: 'https://example.com/room.jpg',
styleImageUrl: 'https://example.com/marble-texture.jpg',
maskUrl: 'https://example.com/mask.png'
};
// Option 2: Use maskBase64 with optional prompt
// const maskBuffer = fs.readFileSync('/path/to/mask.png');
// const maskBase64 = maskBuffer.toString('base64');
// const payload = {
// imageUrl: 'https://example.com/room.jpg',
// styleImageUrl: 'https://example.com/wood-texture.jpg',
// maskBase64: maskBase64,
// prompt: 'natural oak wood grain texture'
// };
const response = await axios.post(
`${BASE_URL}/api/v1/textureReplacer/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);
}
}
createTextureReplacerTask();
📤 レスポンス#
成功時のレスポンス
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| フィールド | 型 | 説明 |
|---|---|---|
code | integer | 0 は成功を示します |
message | string | レスポンスのメッセージ |
data | long | 結果をポーリングするための一意のタスク ID |
2. タスク結果の取得#
作成済みのテクスチャ置換タスクの現在の状態と出力を取得します。
エンドポイント
GET /api/v1/textureReplacer/result
リクエストヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
APIKEY | ✅ はい | API の認証キー |
クエリパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
taskId | long | ✅ はい | タスク作成エンドポイントから返されたタスク ID |
📥 リクエスト例#
cURL
curl -X GET "https://api.ideal.house/api/v1/textureReplacer/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class TextureReplacerResultExample {
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/textureReplacer/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/textureReplacer/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 failed")
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/textureReplacer/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 failed');
}
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",
"styleImageUrl": "https://example.com/marble-texture.jpg",
"maskUrl": "https://example.com/mask.png",
"prompt": "natural marble texture with grey veining"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/texture_replacer_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",
"styleImageUrl": "https://example.com/marble-texture.jpg",
"maskUrl": "https://example.com/mask.png"
},
"output": null
}
}
レスポンス(タスク失敗)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"styleImageUrl": "https://example.com/marble-texture.jpg",
"maskUrl": "https://example.com/mask.png"
},
"output": null
}
}
レスポンスのフィールド
| フィールド | 型 | 説明 |
|---|---|---|
id | long | タスクの一意の識別子 |
status | string | 現在のタスクの状態(タスクの状態を参照) |
waitNumber | integer | キュー内で前に並んでいるタスクの数(0 は現在処理中であることを示します) |
percentage | integer | タスクの完了率(0–100) |
input | object | タスクに指定した元の入力パラメーター |
input.imageUrl | string | 元画像の URL |
input.styleImageUrl | string | スタイル参照画像の URL |
input.maskUrl | string | マスク画像の URL(maskUrl で指定した場合) |
input.prompt | string | 追加のテキストプロンプト(指定した場合) |
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. imageUrl、styleImageUrl、マスクなどの不足) | 必須フィールドがすべて指定されていることを確認する |
5002 | API_KEY_INVALID | API キーが無効または未指定 | APIKEY ヘッダーが存在し、その値が正しいことを確認する |
9010 | SCAN_TEXT_ERROR | テキストプロンプトがコンテンツ審査に通りませんでした | プロンプトを修正し、機微な内容や禁止された内容を除く |
9038 | PROHIBITED_CONTENT | 生成された出力画像に禁止された内容が含まれています | プロンプト、スタイル、入力を調整して再試行する |
9051 | COINS_NOT_ENOUGH | コインまたはクレジットの不足 | アカウントにクレジットを追加して再試行する |
📄 共通の API エラーコードの全一覧は、エラーコードリファレンスを参照してください。
