เอกสาร API แทนที่อย่างชาญฉลาด#
URLพื้นฐาน:
https://api.ideal.house
เวอร์ชัน: v1
อัปเดต: 2026-03-06
📖 ภาพรวม#
แทนที่อย่างชาญฉลาด API ช่วยให้คุณแทนที่พื้นที่ที่เลือกในภาพด้วยเนื้อหาที่สร้างโดย AI ตามคำสั่งข้อความของคุณ คุณต้องให้ภาพต้นฉบับ ภาพ mask ที่กำหนดพื้นที่ที่จะถูกแทนที่ และคำสั่งข้อความที่อธิบายสิ่งที่ควรเติมในพื้นที่นั้น AI จะผสมผสานเนื้อหาที่สร้างเข้ากับภาพต้นฉบับอย่างลงตัว กระบวนการทำงานเป็นแบบ asynchron และประกอบด้วยสองขั้นตอน:
- สร้างงาน — ส่งภาพ mask และคำสั่งของคุณ จากนั้นรับ
taskId. - ตรวจสอบผลลัพธ์ — ใช้
taskIdเพื่อตรวจสอบสถานะงานและรับภาพผลลัพธ์
🔐 การรับรองความถูกต้อง#
คำขอ API ทั้งหมดต้องได้รับการยืนยันตัวตนโดยใช้ คีย์ API
รวมคีย์ API ของคุณในหัวข้อความขอ:
| หัวข้อ | ค่า |
|---|---|
APIKEY | your_api_key_here |
⚠️ รักษาความปลอดภัยคีย์ API ของคุณ อย่าเปิดเผยในโค้ดฝั่งไคลเอนต์หรือรีโพสิทอรีสาธารณะ
💰 การหักเครดิต#
[!WARNING] 🪙 แต่ละงานจะหัก 1 เครดิต ออกจากบัญชีของคุณเมื่อสร้างงานสำเร็จ หากงาน ล้มเหลว ในที่สุด เครดิตที่ถูกหักจะ ถูกคืน เข้าบัญชีของคุณโดยอัตโนมัติ
เครดิตไม่เพียงพอจะคืนรหัสข้อผิดพลาด9051📄 ดู อ้างอิงการหักเครดิต
🖼️ รูปแบบภาพมาสก์#
ภาพ mask กำหนดพื้นที่ที่จะ ถูกแทนที่ ในภาพต้นฉบับ.
กฎของมาสก์:
| สี | ความหมาย |
|---|---|
| ⬛ ดำ | พื้นที่ที่จะถูก แทนที่ (บริเวณที่จะสร้างเนื้อหาใหม่) |
| ⬜ ขาว | พื้นที่ที่จะถูก รักษาไว้ (พื้นหลังที่จะไม่เปลี่ยนแปลง) |
⚠️ ภาพมาสก์ต้อง มีขนาดเดียวกัน กับภาพต้นฉบับ (
imageUrl)
ตัวอย่างมาสก์:
พื้นที่สีดำใน mask ระบุบริเวณที่จะถูกแทนที่โดย AI; พื้นที่สีขาวคือพื้นหลังที่ต้องรักษาไว้.
📌 เอนด์พอยต์ API#
1. สร้างงาน แทนที่อย่างชาญฉลาด#
สร้างงาน AI แทนที่อย่างชาญฉลาด ใหม่และคืน taskId ที่ไม่ซ้ำกันสำหรับการตรวจสอบสถานะเป็นระยะ.
เอนด์พอยต์
POST /api/v1/smartReplace/generate
หัวข้อความขอ
| หัวข้อ | จำเป็น | คำอธิบาย |
|---|---|---|
APIKEY | ✅ ใช่ | คีย์การยืนยันตัวตน API ของคุณ |
Content-Type | ✅ ใช่ | application/json |
เนื้อหาคำขอ
| ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
imageUrl | string | ✅ ใช่ | URL ของภาพต้นฉบับ |
prompt | string | ✅ ใช่ | คำสั่งข้อความที่อธิบายเนื้อหาที่จะสร้างในพื้นที่ mask (e.g., "a modern armchair", "marble flooring") |
maskUrl | string | ⚠️ maskUrl หรือ maskBase64 | URL ของภาพ mask. พื้นที่สีดำจะถูกแทนที่; พื้นที่สีขาวจะถูกเก็บรักษาไว้ |
maskBase64 | string | ⚠️ maskUrl หรือ maskBase64 | ภาพ mask ที่เข้ารหัส Base64 (แนะนำรูปแบบ PNG). ใช้เมื่อคุณไม่สามารถให้ URL ที่โฮสต์ได้ |
⚠️ ต้องให้
maskUrlหรือmaskBase64อย่างน้อยหนึ่งรายการ หากให้ทั้งสองรายการmaskUrlจะมีลำดับความสำคัญสูงกว่า
🖼️ ข้อกำหนดของภาพ: ภาพต้นฉบับและ mask ต้องใช้ JPG/JPEG, PNG หรือ WebP. แต่ละภาพต้องไม่ใหญ่กว่า 20 MB โดยมีขนาดตั้งแต่ 128 × 128 px ถึง 6,000 × 6,000 px (รวมขอบเขต). ภาพที่เกินขนาดพิกเซลสูงสุดจะถูกย่อสัดส่วนลงโดยอัตโนมัติเพื่อให้พอดีกับ 6,000 × 6,000 px ก่อนการประมวลผล. ภาพ URLs ต้องเข้าถึงได้โดยตรงโดยเซิร์ฟเวอร์ API. Mask แบบ Base64 ต้องอยู่ภายใต้ขีดจำกัดของภาพที่ถอดรหัสเช่นเดียวกัน และต้องไม่รวม data-URL prefix.
📥 ตัวอย่างคำขอ#
cURL
# 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)
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)
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)
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();
📤 การตอบสนอง#
คำตอบสำเร็จ
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
code | integer | 0 บ่งชี้ว่าสำเร็จ |
message | string | ข้อความตอบกลับ |
data | long | ID งานเฉพาะสำหรับการตรวจสอบสถานะผลลัพธ์ |
2. รับผลลัพธ์งาน#
ดึงสถานะปัจจุบันและผลลัพธ์ของงาน แทนที่อย่างชาญฉลาด ที่สร้างไว้ก่อนหน้า.
เอนด์พอยต์
GET /api/v1/smartReplace/result
หัวข้อความขอ
| หัวข้อ | จำเป็น | คำอธิบาย |
|---|---|---|
APIKEY | ✅ ใช่ | คีย์การยืนยันตัวตน API ของคุณ |
พารามิเตอร์ควอรี
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
taskId | long | ✅ ใช่ | ID งานที่ส่งกลับจากเอนด์พอยต์สร้างงาน |
📥 ตัวอย่างคำขอ#
cURL
curl -X GET "https://api.ideal.house/api/v1/smartReplace/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
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)
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)
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);
📤 การตอบสนอง#
คำตอบสำเร็จ (งานเสร็จสมบูรณ์)
{
"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
}
}
}
การตอบสนอง (งานกำลังประมวลผล / อยู่ในคิว)
{
"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
}
}
การตอบสนอง (งานล้มเหลว)
{
"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
}
}
ฟิลด์คำตอบ
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
id | long | ตัวระบุเฉพาะของงาน |
status | string | สถานะงานปัจจุบัน (ดู สถานะงาน) |
waitNumber | integer | จำนวนงานที่อยู่ข้างหน้าในคิว (0 หมายถึงกำลังดำเนินการอยู่) |
percentage | integer | ร้อยละความคืบหน้าของงาน (0–100) |
input | object | พารามิเตอร์อินพุตต้นฉบับของงาน |
input.imageUrl | string | ภาพต้นฉบับ URL |
input.prompt | string | คำสั่งข้อความที่อธิบายเนื้อหาที่จะแทนที่ |
input.maskUrl | string | ภาพ mask URL (ถ้าให้ผ่าน maskUrl) |
output | object | ผลลัพธ์การสร้าง (ใช้ได้เฉพาะเมื่อ status เป็น Success) |
output.resultUrl | string | URL ไปยังภาพผลลัพธ์ที่ smart replace แล้ว |
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., prompt หรือ mask ขาดหาย | ตรวจสอบให้แน่ใจว่าให้ทั้ง prompt และฟิลด์ mask อย่างน้อยหนึ่งตัว |
5002 | API_KEY_INVALID | คีย์ API ไม่ถูกต้องหรือไม่พบ | ตรวจสอบว่าเฮดเดอร์ APIKEY มีอยู่และค่าถูกต้อง |
9010 | SCAN_TEXT_ERROR | พรอมต์ข้อความไม่ผ่านการตรวจสอบเนื้อหา | แก้ไขพรอมต์เพื่อลบเนื้อหาอ่อนไหวหรือต้องห้าม |
9038 | PROHIBITED_CONTENT | ภาพผลลัพธ์ที่สร้างมามีเนื้อหาต้องห้าม | ปรับพรอมต์/สไตล์/อินพุตแล้วลองใหม่ |
9051 | COINS_NOT_ENOUGH | เหรียญ/เครดิตไม่เพียงพอ | เติมเครดิตในบัญชีของคุณแล้วลองใหม่ |
📄 สำหรับรายการรหัสข้อผิดพลาด API ทั่วไปทั้งหมด ดู อ้างอิงรหัสข้อผิดพลาด
