Ideal House
跳转到主要内容

纹理替换 API 文档#

基础 URL: https://api.ideal.house
版本: v1
更新: 2026-03-25


📖 概述#

Texture Replacer API 可根据风格参考图像,替换图片中选定区域的纹理或材质。 您需提供一张源图像、一张定义目标纹理/材质的风格参考图像,以及一张 指定需要应用新纹理区域的遮罩图像。AI 会将新纹理无缝融入 原始场景。工作流程为异步处理,包含两个步骤:

  1. 创建任务 — 提交源图像、风格图像、蒙版和参数,然后获取 taskId
  2. 轮询结果 — 使用 taskId 查询任务状态并获取结果图像。

🔐 认证#

所有 API 请求必须使用API 密钥进行认证。

在请求头中包含您的 API 密钥:

头字段
APIKEYyour_api_key_here

⚠️ 妥善保管您的 API 密钥。 切勿在客户端代码或公开仓库中暴露。


💰 积分扣除#

[!WARNING] 🪙 成功创建任务后扣除3 积分。如果任务最终失败,扣除的积分将自动退还到您的账户。
积分不足将返回错误码 9051。📄 详见积分扣除参考

操作扣除积分
纹理替换任务3 积分

🖼️ 蒙版图像格式#

蒙版图像定义了纹理替换将应用的区域。

蒙版规则:

颜色含义
黑色应用新纹理的区域(待替换的区域)
白色保留的区域(保持不变的背景)

⚠️ 蒙版图像必须与源图像(imageUrl尺寸相同

蒙版示例:

蒙版示例

蒙版中的黑色区域定义了将应用新纹理的位置;白色区域是需要 保留的背景。


📌 API 端点#


1. 创建纹理替换任务#

创建新的 AI 纹理替换任务并返回用于轮询的唯一 taskId

端点

纯文本
POST /api/v1/textureReplacer/generate

请求头

头字段必填描述
APIKEY✅ 是您的 API 认证密钥
Content-Type✅ 是application/json

请求体

字段类型必填描述
imageUrlstring✅ 是源图像的 URL(要应用纹理的房间/场景)
styleImageUrlstring✅ 是定义目标纹理或材质的风格参考图像的 URL
maskUrlstring⚠️ maskUrlmaskBase64 二选一蒙版图像的 URL。黑色区域将应用新纹理;白色区域将被保留
maskBase64string⚠️ maskUrlmaskBase64 二选一Base64 编码的蒙版图像(推荐使用 PNG 格式)。当您无法提供托管的 URL 时使用
promptstring❌ 可选用于进一步引导纹理生成的附加文本提示

⚠️ 必须提供 maskUrlmaskBase64 至少一个。 如果两者都提供,maskUrl 优先。

🖼️ 图像要求: 源图像、风格图像和蒙版图像必须使用 JPG/JPEG、PNG 或 WebP 格式。每张图像不得超过 20 MB,尺寸范围为 128 × 128 px6,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/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)
java
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)
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",
    "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)
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 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();

📤 响应#

成功响应

json
{
  "code": 0,
  "message": "success",
  "data": 1234567890123456789
}
字段类型描述
codeinteger0 表示成功
messagestring响应消息
datalong用于轮询结果的任务唯一 ID

2. 获取任务结果#

获取之前创建的纹理替换任务的当前状态和输出。

端点

纯文本
GET /api/v1/textureReplacer/result

请求头

头字段必填描述
APIKEY✅ 是您的 API 认证密钥

查询参数

参数类型必填描述
taskIdlong✅ 是创建任务端点返回的任务 ID

📥 请求示例#

cURL
bash
curl -X GET "https://api.ideal.house/api/v1/textureReplacer/result?taskId=1234567890123456789" \
  -H "APIKEY: your_api_key_here"
Java (OkHttp)
java
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)
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/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)
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/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);

📤 响应#

成功响应(任务已完成)

json
{
  "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
    }
  }
}

响应(任务处理中 / 排队中)

json
{
  "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
  }
}

响应(任务失败)

json
{
  "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
  }
}

响应字段

字段类型描述
idlong任务唯一标识符
statusstring当前任务状态(参见任务状态
waitNumberinteger队列中排在任务前面的数量(0 表示正在处理)
percentageinteger任务完成百分比(0–100
inputobject任务的原始输入参数
input.imageUrlstring源图像 URL
input.styleImageUrlstring风格参考图像 URL
input.maskUrlstring蒙版图像 URL(如通过 maskUrl 提供)
input.promptstring附加文本提示(如提供)
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., imageUrl, styleImageUrl 或蒙版缺失确保提供了所有必填字段
5002API_KEY_INVALIDAPI 密钥无效或缺失确保 APIKEY 头字段存在且值正确
9010SCAN_TEXT_ERROR文本提示未通过内容审核修改提示以移除敏感或禁止的内容
9038PROHIBITED_CONTENT生成的输出图像包含禁止内容调整提示/风格/输入后重试
9051COINS_NOT_ENOUGH积分/硬币不足为您的账户充值积分后重试

📄 常见 API 错误码完整列表,请参阅错误码参考