Ideal House
ข้ามไปยังเนื้อหา

เอกสาร API การสร้างโมเดล 3D ด้วย AI#

URLพื้นฐาน: https://api.ideal.house
เวอร์ชัน: v1
อัปเดต: 2026-03-06


📖 ภาพรวม#

API การสร้างโมเดล 3D ด้วย AI ช่วยให้คุณส่งงานสร้าง 3D จากภาพหรือข้อความคำสั่ง และรับผลลัพธ์แบบไม่ซิงโครนัส กระบวนการทำงานประกอบด้วยสองขั้นตอน:

  1. สร้างงาน — ส่งข้อมูลนำเข้า (URL ของภาพ หรือข้อความคำสั่ง) และรับ taskId
  2. ตรวจสอบผลลัพธ์ — ใช้ taskId เพื่อสอบถามสถานะงานและรับผลลัพธ์ที่สร้างแล้ว

🔐 การรับรองความถูกต้อง#

คำขอ API ทั้งหมดต้องได้รับการยืนยันตัวตนโดยใช้ คีย์ API

รวมคีย์ API ของคุณในหัวข้อความขอ:

หัวข้อค่า
APIKEYyour_api_key_here

⚠️ รักษาความปลอดภัยคีย์ API ของคุณ อย่าเปิดเผยในโค้ดฝั่งไคลเอนต์หรือรีโพสิทอรีสาธารณะ


⚡ ข้อจำกัดความถี่พร้อมกัน#

🚦 สำคัญ: API นี้รองรับ 1 คำขอพร้อมกันต่อบัญชี ในแต่ละครั้งเท่านั้น
หากส่งคำขอหลายรายการพร้อมกัน คำขอถัดไปจะถูกจัดเข้า คิว และประมวลผลตามลำดับ
คุณสามารถตรวจสอบตำแหน่งในคิวของคุณผ่านฟิลด์ waitNumber ในคำตอบผลลัพธ์ของงาน


💰 การหักเครดิต#

[!WARNING] 🪙 แต่ละงานจะหัก 20 เครดิต ออกจากบัญชีของคุณเมื่อสร้างงานสำเร็จ
เครดิตจะถูกหักในขณะสร้างงาน หากงาน ล้มเหลว ในที่สุด เครดิตที่ถูกหักจะ คืนอัตโนมัติ เข้าบัญชีของคุณ
เครดิตไม่เพียงพอจะคืนรหัสข้อผิดพลาด 9051 📄 ดู อ้างอิงการหักเครดิต


📌 เอนด์พอยต์ API#


1. สร้างงาน 3D#

สร้างงาน 3D ใหม่ และคืน taskId ที่ไม่ซ้ำกันสำหรับการตรวจสอบสถานะเป็นระยะ

เอนด์พอยต์

ข้อความธรรมดา
POST /api/v1/ai3d/generate

หัวข้อความขอ

หัวข้อจำเป็นคำอธิบาย
APIKEY✅ ใช่คีย์ API สำหรับยืนยันตัวตนของคุณ
Content-Type✅ ใช่application/json

เนื้อหาคำขอ

ฟิลด์ประเภทจำเป็นคำอธิบาย
imageUrlstring⚠️ ต้องระบุ imageUrl หรือ promptURL ของภาพต้นฉบับที่จะใช้สร้าง 3D
promptstring⚠️ ต้องระบุ imageUrl หรือ promptพรอมต์ข้อความที่อธิบายเนื้อหา 3D ที่ต้องการสร้าง

💡 หมายเหตุ: imageUrl และ prompt เป็นทางเลือกที่ตัดกัน — ระบุเพียงหนึ่งในสองรายการต่อคำขอ

🖼️ ข้อกำหนดของภาพ: ใช้ JPG/JPEG, PNG หรือ WebP แต่ละภาพต้องมีขนาดไม่เกิน 20 MB โดยมีขนาดตั้งแต่ 128 × 128 px ถึง 5,000 × 5,000 px (รวมขอบเขต) URL ของภาพต้องเข้าถึงได้โดยตรงโดยเซิร์ฟเวอร์ API


📥 ตัวอย่างคำขอ#

cURL
bash
# Using imageUrl
curl -X POST "https://api.ideal.house/api/v1/ai3d/generate" \
  -H "APIKEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "imageUrl": "https://example.com/room.jpg"
  }'

# Using prompt
curl -X POST "https://api.ideal.house/api/v1/ai3d/generate" \
  -H "APIKEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A modern minimalist living room with wooden floor"
  }'
Java (OkHttp)
java
import okhttp3.*;
import java.io.IOException;

public class Ai3dApiExample {

    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();

        String requestBody = """
            {
                "imageUrl": "https://example.com/room.jpg"
            }
            """;

        Request request = new Request.Builder()
            .url(BASE_URL + "/api/v1/ai3d/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

BASE_URL = "https://api.ideal.house"
API_KEY  = "your_api_key_here"

headers = {
    "APIKEY": API_KEY,
    "Content-Type": "application/json"
}

# Using imageUrl
payload = {
    "imageUrl": "https://example.com/room.jpg"
}

# Or using prompt
# payload = {
#     "prompt": "A modern minimalist living room with wooden floor"
# }

response = requests.post(
    f"{BASE_URL}/api/v1/ai3d/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 BASE_URL = 'https://api.ideal.house';
const API_KEY  = 'your_api_key_here';

async function createTask() {
  try {
    const response = await axios.post(
      `${BASE_URL}/api/v1/ai3d/generate`,
      {
        imageUrl: 'https://example.com/room.jpg'
        // Or use prompt instead:
        // prompt: 'A modern minimalist living room with wooden floor',
      },
      {
        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);
  }
}

createTask();

📤 การตอบสนอง#

คำตอบสำเร็จ

json
{
  "code": 0,
  "message": "success",
  "data": 1234567890123456789
}
ฟิลด์ประเภทคำอธิบาย
codeinteger0 บ่งชี้ว่าสำเร็จ
messagestringข้อความตอบกลับ
datalongรหัสงานที่ไม่ซ้ำกันสำหรับการตรวจสอบสถานะ

2. รับผลลัพธ์งาน#

ดึงสถานะปัจจุบันและผลลัพธ์ของงานที่สร้างไว้ก่อนหน้า

เอนด์พอยต์

ข้อความธรรมดา
GET /api/v1/ai3d/result

หัวข้อความขอ

หัวข้อจำเป็นคำอธิบาย
APIKEY✅ ใช่คีย์ API สำหรับยืนยันตัวตนของคุณ

พารามิเตอร์คิวรี

พารามิเตอร์ประเภทจำเป็นคำอธิบาย
taskIdlong✅ ใช่รหัสงานที่คืนจากเอนด์พอยต์สร้างงาน

📥 ตัวอย่างคำขอ#

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

public class Ai3dResultExample {

    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/ai3d/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/ai3d/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 or terminated")
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/ai3d/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);

📤 การตอบสนอง#

คำตอบสำเร็จ (งานเสร็จสมบูรณ์)

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Success",
    "waitNumber": 0,
    "percentage": 100,
    "input": {
      "imageUrl": "https://example.com/room.jpg"
    },
    "output": {
      "resultUrl": "https://cdn.ideal.house/output/result_3d_model.zip",
      "width": 1024,
      "height": 1024
    }
  }
}

การตอบสนอง (งานกำลังประมวลผล / อยู่ในคิว)

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Processing",
    "waitNumber": 2,
    "percentage": 35,
    "input": {
      "imageUrl": "https://example.com/room.jpg"
    },
    "output": null
  }
}

การตอบสนอง (งานล้มเหลว)

json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1234567890123456789,
    "status": "Failed",
    "waitNumber": 0,
    "percentage": 0,
    "input": {
      "imageUrl": "https://example.com/room.jpg"
    },
    "output": null
  }
}

ฟิลด์คำตอบ

ฟิลด์ประเภทคำอธิบาย
idlongตัวระบุเฉพาะของงาน
statusstringสถานะงานปัจจุบัน (ดู สถานะงาน)
waitNumberintegerจำนวนงานที่อยู่ข้างหน้าในคิว (0 หมายถึงกำลังประมวลผล)
percentageintegerร้อยละความคืบหน้าของงาน (0–100)
inputobjectพารามิเตอร์อินพุตเดิมของงาน
input.imageUrlstringURL ของภาพต้นฉบับ (หากมี)
input.promptstringพรอมต์ข้อความต้นฉบับ (หากมี)
input.modelTypestringประเภทโมเดลที่ใช้
outputobjectผลลัพธ์การสร้าง (พร้อมใช้งานเฉพาะเมื่อ status เป็น Success)
output.resultUrlstringURL ไปยังไฟล์โมเดล 3D ที่สร้างแล้ว
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ข้อผิดพลาดพารามิเตอร์คำขอตรวจสอบว่าพารามิเตอร์ที่จำเป็นทั้งหมดถูกให้มาและจัดรูปแบบถูกต้อง
5002API_KEY_INVALIDคีย์ API ไม่ถูกต้องหรือไม่พบตรวจสอบว่าเฮดเดอร์ APIKEY มีอยู่และค่าถูกต้อง
9010SCAN_TEXT_ERRORคำสั่งข้อความไม่ผ่านการตรวจสอบเนื้อหาแก้ไขคำสั่งเพื่อลบเนื้อหาที่อ่อนไหวหรือห้ามใช้
9038PROHIBITED_CONTENTภาพผลลัพธ์ที่สร้างมามีเนื้อหาที่ห้ามใช้ปรับคำสั่ง/สไตล์/อินพุตและลองใหม่
9036COVERT_3D_FAILEDภาพนี้ไม่รองรับการสร้าง 3Dลองใช้ภาพอื่นที่มีโครงสร้างและความลึกชัดเจนกว่า
9051COINS_NOT_ENOUGHเหรียญ/เครดิตไม่เพียงพอเติมเครดิตในบัญชีของคุณแล้วลองใหม่

ตัวอย่างคำตอบผิดพลาด#

5002 — API ไม่ถูกต้อง
json
{
  "code": 5002,
  "message": "Invalid API Key",
  "data": null
}
1011 — ข้อผิดพลาดของพารามิเตอร์
json
{
  "code": 1011,
  "message": "Request parameter error: imageUrl is required",
  "data": null
}
9036 — ภาพไม่รองรับการสร้าง 3D
json
{
  "code": 9036,
  "message": "This image does not support 3D generation",
  "data": null
}
9010 — การตรวจสอบเนื้อหาข้อความล้มเหลว
json
{
  "code": 9010,
  "message": "Text prompt failed content review, contains prohibited content",
  "data": null
}
9051 — เครดิตไม่เพียงพอ
json
{
  "code": 9051,
  "message": "Insufficient coins",
  "data": null
}

📄 สำหรับรายการรหัสข้อผิดพลาด API ทั่วไปทั้งหมด ดู อ้างอิงรหัสข้อผิดพลาด