Ideal House
コンテンツにスキップ

AI 3D 生成 API ドキュメント#

ベース URL: https://api.ideal.house
バージョン: v1
更新日: 2026-03-06


📖 概要#

AI 3D 生成 API は、画像またはプロンプトに基づく 3D 生成タスクを送信し、その結果を非同期で取得できます。次の二つの手順で行います。

  1. タスクを作成する — 入力(画像の URL またはテキストプロンプト)を送信し、taskId を受け取ります。
  2. 結果をポーリングするtaskId でタスクの状態を照会し、生成された出力を取得します。

🔐 認証#

すべての API リクエストは API キー で認証する必要があります。

リクエストヘッダーに API キーを含めます。

ヘッダー
APIKEYyour_api_key_here

⚠️ API キーは安全に保管してください。 クライアント側のコードや公開リポジトリに公開しないでください。


⚡ 同時実行制限#

🚦 重要: この API では、同時に実行できるリクエストは アカウントごとに 1 件 だけです。
複数のリクエストを同時に送信した場合、後続のリクエストは キュー に入れられ、順番に処理されます。
タスク結果レスポンスの waitNumber フィールドで、キュー内の位置を確認できます。


💰 クレジットの消費#

[!WARNING] 🪙 タスクが正常に作成されると、アカウントから タスクごとに 20 クレジット が差し引かれます。
クレジットはタスクの作成時に差し引かれます。タスクが最終的に 失敗 した場合、差し引かれたクレジットはアカウントに 自動的に返還 されます。
クレジット不足の場合、エラーコード 9051 が返ります。📄 クレジット消費リファレンスを参照してください。


📌 API エンドポイント#


1. 3D 生成タスクの作成#

新しい AI 3D 生成タスクを作成し、ポーリング用の一意の taskId を返します。

エンドポイント

プレーンテキスト
POST /api/v1/ai3d/generate

リクエストヘッダー

ヘッダー必須説明
APIKEY✅ はいAPI の認証キー
Content-Type✅ はいapplication/json

リクエストボディ

フィールド必須説明
imageUrlstring⚠️ imageUrl または prompt のいずれかが必須3D 生成に使用する元画像の URL
promptstring⚠️ imageUrl または prompt のいずれかが必須生成する 3D コンテンツを説明するテキストプロンプト

💡 注意: imageUrlprompt は同時に指定できません。リクエストごとにどちらか一方を指定してください。

🖼️ 画像の要件: 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結果をポーリングするための一意のタスク ID

2. タスク結果の取得#

作成済みのタスクの現在の状態と出力を取得します。

エンドポイント

プレーンテキスト
GET /api/v1/ai3d/result

リクエストヘッダー

ヘッダー必須説明
APIKEY✅ はいAPI の認証キー

クエリパラメーター

パラメーター必須説明
taskIdlong✅ はいタスク作成エンドポイントから返されたタスク ID

📥 リクエスト例#

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.imageUrlstring元画像の URL(指定した場合)
input.promptstring元のテキストプロンプト(指定した場合)
input.modelTypestring使用したモデルの種類
outputobject生成結果(statusSuccess の場合のみ利用可能)
output.resultUrlstring生成された 3D モデルファイルの 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リクエストパラメーターのエラー必須パラメーターがすべて指定され、形式が正しいことを確認する
5002API_KEY_INVALIDAPI キーが無効または未指定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 エラーコードの全一覧は、エラーコードリファレンスを参照してください。