เอกสาร API การเรนเดอร์ 3D ด้วย AI#
URLพื้นฐาน:
https://api.ideal.house
เวอร์ชัน: v1
อัปเดต: 2026-03-06
📖 ภาพรวม#
API การเรนเดอร์ 3D ด้วย AI ช่วยให้คุณส่งงาน 3D จากภาพต้นฉบับ พร้อมควบคุมระดับการเรนเดอร์ โหมดการเรนเดอร์ ข้อความคำสั่งแบบไม่บังคับ และภาพสไตล์อ้างอิง กระบวนการทำงานแบบไม่ซิงโครนัสประกอบด้วยสองขั้นตอน:
- สร้างงาน — ส่งพารามิเตอร์นำเข้าของคุณและรับ
taskId - ตรวจสอบผลลัพธ์ — ใช้
taskIdเพื่อสอบถามสถานะงานและรับผลลัพธ์ที่สร้างแล้ว
🔐 การรับรองความถูกต้อง#
คำขอ API ทั้งหมดต้องได้รับการยืนยันตัวตนโดยใช้ คีย์ API
รวมคีย์ API ของคุณในหัวข้อความขอ:
| หัวข้อ | ค่า |
|---|---|
APIKEY | your_api_key_here |
⚠️ รักษาความปลอดภัยคีย์ API ของคุณ อย่าเปิดเผยในโค้ดฝั่งไคลเอนต์หรือรีโพสิทอรีสาธารณะ
💰 การหักเครดิต#
[!WARNING] 🪙 เครดิตจะถูกหักตาม
modelTypeที่เลือกเมื่อสร้างงานสำเร็จ หากงาน ล้มเหลว ในที่สุด เครดิตที่ถูกหักจะ ถูกคืน เข้าบัญชีของคุณโดยอัตโนมัติ
เครดิตไม่เพียงพอจะคืนรหัสข้อผิดพลาด9051📄 ดู อ้างอิงการหักเครดิต
โมเดล (modelType) | เครดิตที่หัก |
|---|---|
Flash | 1 เครดิต |
Base | 3 เครดิต |
Pro | 10 เครดิต |
📌 เอนด์พอยต์ API#
1. สร้างงาน 3D#
สร้างงานเรนเดอร์ 3D ใหม่ของ AI และคืน taskId ที่ไม่ซ้ำกันสำหรับการตรวจสอบสถานะ
เอนด์พอยต์
POST /api/v1/ai3dRendering/generate
หัวข้อความขอ
| หัวข้อ | จำเป็น | คำอธิบาย |
|---|---|---|
APIKEY | ✅ ใช่ | คีย์ API สำหรับยืนยันตัวตนของคุณ |
Content-Type | ✅ ใช่ | application/json |
เนื้อหาคำขอ
| ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
imageUrl | string | ✅ ใช่ | URL ของภาพต้นฉบับที่จะเรนเดอร์ |
prompt | string | ❌ ไม่บังคับ | พรอมต์ข้อความเพิ่มเติมเพื่อแนะนำสไตล์หรือเนื้อหาการเรนเดอร์ |
modelType | string | ❌ ไม่บังคับ | ประเภทคุณภาพของโมเดล Enum: Flash, Base, Pro ค่าเริ่มต้นคือ Flash |
renderDegree | integer | ❌ ไม่บังคับ | ระดับความเข้มของการเรนเดอร์ ช่วง: 1 (เบาที่สุด) – 6 (แรงที่สุด) ค่าเริ่มต้นคือ 3 มีผลเฉพาะเมื่อ modelType เป็น Flash |
renderMode | string | ❌ ไม่บังคับ | โหมดการเรนเดอร์ Enum: default, creativeMode ค่าเริ่มต้นคือ default |
refImageUrl | string | ❌ ไม่บังคับ | URL ของภาพสไตล์อ้างอิงเพื่อแนะนำผลลัพธ์การเรนเดอร์ |
⚠️ หมายเหตุ:
renderDegreeมีผลเฉพาะเมื่อmodelTypeตั้งค่าเป็นFlashหากไม่ได้ระบุmodelTypeจะใช้Flashเป็นค่าเริ่มต้น
🖼️ ข้อกำหนดของภาพ: ภาพนำเข้าและภาพอ้างอิงทั้งหมดต้องใช้ JPG/JPEG, PNG หรือ WebP แต่ละภาพต้องมีขนาดไม่เกิน 20 MB โดยมีขนาดตั้งแต่ 128 × 128 px ถึง 6,000 × 6,000 px (รวมขอบเขต) ภาพที่มีขนาดพิกเซลเกินขีดจำกัดสูงสุดจะถูกย่อขนาดตามสัดส่วนให้อยู่ภายใน 6,000 × 6,000 px ก่อนการประมวลผล URLs ของภาพต้องเข้าถึงได้โดยตรงโดยเซิร์ฟเวอร์ API
ประเภทโมเดล
| ค่า | คำอธิบาย |
|---|---|
Flash | ค่าเริ่มต้น ความเร็วในการสร้างเร็วที่สุด คุณภาพมาตรฐาน รองรับการควบคุม renderDegree |
Base | สมดุลระหว่างความเร็วและคุณภาพ renderDegree จะถูกเพิกเฉย |
Pro | คุณภาพสูงสุด การสร้างช้าลง renderDegree จะถูกเพิกเฉย |
โหมดการเรนเดอร์
| ค่า | คำอธิบาย |
|---|---|
default | โหมดเริ่มต้น รักษาพื้นผิวและโครงสร้างของภาพต้นฉบับไว้ระหว่างการเรนเดอร์ (โหมดรักษาพื้นผิว) |
creativeMode | โหมดสร้างสรรค์ — ใช้การแปลงสไตล์การเรนเดอร์แบบศิลปะมากขึ้น |
ระดับการเรนเดอร์
| ค่า | คำอธิบาย |
|---|---|
1 | การเรนเดอร์เบาที่สุด — การแปลงน้อยที่สุด |
2 – 5 | ความเข้มของการเรนเดอร์แบบก้าวหน้า |
6 | การเรนเดอร์แรงที่สุด — การแปลงสูงสุด |
📥 ตัวอย่างคำขอ#
cURL
# Using Flash model with renderDegree (texture preservation mode)
curl -X POST "https://api.ideal.house/api/v1/ai3dRendering/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
}'
# Using Flash model with creative mode, prompt and a reference image
curl -X POST "https://api.ideal.house/api/v1/ai3dRendering/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"prompt": "A modern minimalist living room with wooden floor",
"modelType": "Flash",
"renderDegree": 5,
"renderMode": "creativeMode",
"refImageUrl": "https://example.com/style-reference.jpg"
}'
# Using Pro model (renderDegree is ignored)
curl -X POST "https://api.ideal.house/api/v1/ai3dRendering/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"modelType": "Pro",
"renderMode": "default"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class Ai3dRenderingApiExample {
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();
// Flash model with renderDegree (renderDegree only works with Flash)
String requestBody = """
{
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
}
""";
// Pro model example (renderDegree is ignored)
// String requestBody = """
// {
// "imageUrl": "https://example.com/room.jpg",
// "modelType": "Pro",
// "renderMode": "default"
// }
// """;
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/ai3dRendering/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
BASE_URL = "https://api.ideal.house"
API_KEY = "your_api_key_here"
headers = {
"APIKEY": API_KEY,
"Content-Type": "application/json"
}
# Flash model — renderDegree takes effect (default texture preservation mode)
payload = {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
}
# Flash model with creative mode, prompt and reference image
# payload = {
# "imageUrl": "https://example.com/room.jpg",
# "prompt": "A modern minimalist living room with wooden floor",
# "modelType": "Flash",
# "renderDegree": 5,
# "renderMode": "creativeMode",
# "refImageUrl": "https://example.com/style-reference.jpg"
# }
# Pro model — renderDegree is ignored
# payload = {
# "imageUrl": "https://example.com/room.jpg",
# "modelType": "Pro",
# "renderMode": "default"
# }
response = requests.post(
f"{BASE_URL}/api/v1/ai3dRendering/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 BASE_URL = 'https://api.ideal.house';
const API_KEY = 'your_api_key_here';
async function createRenderingTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/ai3dRendering/generate`,
{
// Flash model — renderDegree takes effect
imageUrl: 'https://example.com/room.jpg',
modelType: 'Flash',
renderDegree: 4,
renderMode: 'default'
// Flash model with creative mode:
// prompt: 'A modern minimalist living room with wooden floor',
// modelType: 'Flash',
// renderDegree: 5,
// renderMode: 'creativeMode',
// refImageUrl: 'https://example.com/style-reference.jpg'
// Pro model — renderDegree is ignored:
// imageUrl: 'https://example.com/room.jpg',
// modelType: 'Pro',
// renderMode: 'default'
},
{
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);
}
}
createRenderingTask();
📤 การตอบสนอง#
คำตอบสำเร็จ
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
code | integer | 0 บ่งชี้ว่าสำเร็จ |
message | string | ข้อความตอบกลับ |
data | long | รหัสงานที่ไม่ซ้ำกันสำหรับการตรวจสอบสถานะ |
2. รับผลลัพธ์งาน#
ดึงสถานะปัจจุบันและผลลัพธ์ของงานเรนเดอร์ที่สร้างไว้ก่อนหน้า
เอนด์พอยต์
GET /api/v1/ai3dRendering/result
หัวข้อความขอ
| หัวข้อ | จำเป็น | คำอธิบาย |
|---|---|---|
APIKEY | ✅ ใช่ | คีย์ API สำหรับยืนยันตัวตนของคุณ |
พารามิเตอร์คิวรี
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
taskId | long | ✅ ใช่ | รหัสงานที่คืนจากเอนด์พอยต์สร้างงาน |
📥 ตัวอย่างคำขอ#
cURL
curl -X GET "https://api.ideal.house/api/v1/ai3dRendering/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class Ai3dRenderingResultExample {
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/ai3dRendering/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/ai3dRendering/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/ai3dRendering/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);
} 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",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/rendered_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",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
},
"output": null
}
}
การตอบสนอง (งานล้มเหลว)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash",
"renderDegree": 4,
"renderMode": "default"
},
"output": null
}
}
ฟิลด์คำตอบ
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
id | long | ตัวระบุเฉพาะของงาน |
status | string | สถานะงานปัจจุบัน (ดู สถานะงาน) |
waitNumber | integer | จำนวนงานที่อยู่ข้างหน้าในคิว (0 หมายถึงกำลังประมวลผล) |
percentage | integer | ร้อยละความคืบหน้าของงาน (0–100) |
input | object | พารามิเตอร์อินพุตเดิมของงาน |
input.imageUrl | string | URL ของภาพต้นฉบับ (หากมี) |
input.prompt | string | พรอมต์ข้อความต้นฉบับ (หากมี) |
input.modelType | string | ประเภทโมเดลที่ใช้ |
input.renderDegree | integer | ระดับความเข้มของการเรนเดอร์ที่ใช้ (1–6) |
input.renderMode | string | โหมดการเรนเดอร์ที่ใช้ (default หรือ creativeMode) |
input.refImageUrl | string | URL ของภาพสไตล์อ้างอิง (หากมี) |
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 | ข้อผิดพลาดพารามิเตอร์คำขอ | ตรวจสอบว่าพารามิเตอร์ที่จำเป็นทั้งหมดถูกให้มาและจัดรูปแบบถูกต้อง |
5002 | API_KEY_INVALID | คีย์ API ไม่ถูกต้องหรือไม่พบ | ตรวจสอบว่าเฮดเดอร์ APIKEY มีอยู่และค่าถูกต้อง |
9010 | SCAN_TEXT_ERROR | คำสั่งข้อความไม่ผ่านการตรวจสอบเนื้อหา | แก้ไขคำสั่งเพื่อลบเนื้อหาที่อ่อนไหวหรือห้ามใช้ |
9038 | PROHIBITED_CONTENT | ภาพผลลัพธ์ที่สร้างมามีเนื้อหาที่ห้ามใช้ | ปรับคำสั่ง/สไตล์/อินพุตและลองใหม่ |
9051 | COINS_NOT_ENOUGH | เหรียญ/เครดิตไม่เพียงพอ | เติมเครดิตในบัญชีของคุณแล้วลองใหม่ |
📄 สำหรับรายการรหัสข้อผิดพลาด API ทั่วไปทั้งหมด ดู อ้างอิงรหัสข้อผิดพลาด