Ideal House
Przejdź do treści

Dokumentacja generowania AI 3D API#

Podstawowy URL: https://api.ideal.house
Wersja: v1
Zaktualizowano: 2026-03-06


📖 Przegląd#

Interfejs AI 3D Generation API umożliwia wysyłanie zadań generowania 3D opartych na obrazie lub poleceniu tekstowym oraz pobieranie ich wyników asynchronicznie. Praca obejmuje dwa kroki:

  1. Utwórz zadanie — Prześlij dane wejściowe (adres URL obrazu lub polecenie tekstowe) i otrzymaj taskId.
  2. Sprawdzaj wyniki — Użyj identyfikatora taskId, aby cyklicznie sprawdzać status zadania i pobrać wygenerowany wynik.

🔐 Uwierzytelnianie#

Wszystkie żądania API muszą być uwierzytelniane za pomocą klucza API Key.

Włącz swój klucz API Key w nagłówku żądania:

NagłówekWartość
APIKEYyour_api_key_here

⚠️ Zachowaj swój klucz API Key w tajemnicy. Nie ujawniaj go w kodzie po stronie klienta ani w publicznych repozytoriach.


⚡ Limit współbieżności#

🚦 Ważne: Ten interfejs API pozwala na 1 równoległe żądanie na konto w danym momencie.
Jeśli wiele żądań zostanie wysłanych jednocześnie, kolejne żądania zostaną umieszczone w kolejce i przetwarzane w kolejności.
Pozycję w kolejce można monitorować za pomocą pola waitNumber w odpowiedzi z wynikiem zadania.


💰 Odejmowanie kredytów#

[!WARNING] 🪙 Każde zadanie pobiera 20 kredytów z konta po pomyślnym utworzeniu zadania.
Kredyty są pobierane w momencie utworzenia zadania. Jeśli zadanie ostatecznie zawiedzie, pobrane kredyty zostaną automatycznie zwrócone na konto.
Niewystarczające kredyty spowodują zwrócenie kodu błędu 9051. 📄 Zobacz Referencja odejmowania kredytów.


📌 Punkty końcowe API#


1. Utwórz zadanie generowania 3D#

Tworzy nowe zadanie generowania AI 3D i zwraca unikalny identyfikator taskId do cyklicznego sprawdzania statusu.

Punkt końcowy

Zwykły tekst
POST /api/v1/ai3d/generate

Nagłówki żądania

NagłówekWymaganyOpis
APIKEY✅ TakTwój klucz uwierzytelniający API
Content-Type✅ Takapplication/json

Ciało żądania

PoleTypWymaganeOpis
imageUrlstring⚠️ Wymagane jest imageUrl lub promptAdres URL obrazu źródłowego, z którego ma zostać wygenerowany model 3D
promptstring⚠️ Wymagane jest imageUrl lub promptPolecenie tekstowe opisujące treść 3D do wygenerowania

💡 Uwaga: Parametry imageUrl i prompt są wzajemnie wykluczające się — podaj jedno z nich w żądaniu.

🖼️ Wymagania dotyczące obrazów: Używaj formatów JPG/JPEG, PNG lub WebP. Każdy obraz nie może być większy niż 20 MB, a jego wymiary muszą mieścić się w zakresie od 128 × 128 px do 5,000 × 5,000 px (włącznie). Adres URL obrazu musi być bezpośrednio dostępny dla serwera API.


📥 Przykłady żądań#

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

📤 Odpowiedź#

Odpowiedź sukcesu

json
{
  "code": 0,
  "message": "success",
  "data": 1234567890123456789
}
PoleTypOpis
codeinteger0 oznacza sukces
messagestringKomunikat odpowiedzi
datalongUnikalny identyfikator zadania do sprawdzania wyników

2. Pobranie wyniku zadania#

Pobiera bieżący status i wynik wcześniej utworzonego zadania.

Punkt końcowy

Zwykły tekst
GET /api/v1/ai3d/result

Nagłówki żądania

NagłówekWymaganyOpis
APIKEY✅ TakTwój klucz uwierzytelniający API

Parametry zapytania

ParametrTypWymaganyOpis
taskIdlong✅ TakIdentyfikator zadania zwrócony z endpointu tworzenia zadania

📥 Przykłady żądań#

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

📤 Odpowiedź#

Odpowiedź sukcesu (Zadanie zakończone)

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
    }
  }
}

Odpowiedź (Zadanie w trakcie przetwarzania / W kolejce)

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

Odpowiedź (Zadanie nie powiodło się)

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

Pola odpowiedzi

PoleTypOpis
idlongUnikalny identyfikator zadania
statusstringBieżący status zadania (zobacz Status zadania)
waitNumberintegerLiczba zadań przed Tobą w kolejce (0 oznacza, że zadanie jest obecnie przetwarzane)
percentageintegerProcent ukończenia zadania (0–100)
inputobjectOryginalne parametry wejściowe zadania
input.imageUrlstringAdres URL obrazu źródłowego (jeśli podano)
input.promptstringPolecenie tekstowe źródłowe (jeśli podano)
input.modelTypestringużyty typ modelu
outputobjectWynik generacji (dostępny tylko, gdy status wynosi Success)
output.resultUrlstringAdres URL do wygenerowanego pliku modelu 3D
output.widthintegerSzerokość wyjścia w pikselach
output.heightintegerWysokość wyjścia w pikselach

📊 Status zadania#

StatusOpis
UnprocessedZadanie zostało utworzone, ale nie zostało jeszcze rozpoczęte
ProcessingZadanie jest obecnie przetwarzane
SuccessZadanie zakończyło się pomyślnie — wynik jest dostępny
FailedZadanie nie powiodło się z powodu błędu

Wykonuj cykliczne sprawdzanie co 3-5 sekund. Zobacz Limit zadań API.


❌ Odpowiedzi błędów#

Wszystkie odpowiedzi błędów mają tę samą strukturę JSON:

json
{
  "code": 5002,
  "message": "Invalid API Key",
  "data": null
}

Referencja kodów błędów#

KodNazwaOpisSugerowane działanie
1001FAILEDŻądanie nie powiodło się (błąd ogólny)Sprawdź pole message, aby uzyskać szczegółowe informacje o błędzie
1003INTERNAL_ERRORWewnętrzny błąd serweraPonów próbę po krótkim opóźnieniu; skontaktuj się z pomocą techniczną, jeśli problem utrzymuje się
1011PARAM_ERRORbłąd parametru żądaniaZweryfikuj, czy wszystkie wymagane parametry są podane i poprawnie sformatowane
5002API_KEY_INVALIDNieprawidłowy lub brakujący klucz APIUpewnij się, że nagłówek APIKEY jest obecny i ma poprawną wartość
9010SCAN_TEXT_ERRORWskazówka tekstowa nie przeszła weryfikacji treściZmodyfikuj wskazówkę, aby usunąć wszelkie treści wrażliwe lub zakazane
9038PROHIBITED_CONTENTWygenerowany obraz wyjściowy zawiera treści zakazaneDostosuj wskazówkę/styl/wejścia i ponów próbę
9036COVERT_3D_FAILEDTen obraz nie obsługuje generowania 3DWypróbuj inny obraz o wyraźniejszej strukturze i głębi
9051COINS_NOT_ENOUGHniewystarczające monety / kredytyDoładuj kredyty na swoim koncie i ponów

Przykłady odpowiedzi błędów#

5002 — Nieprawidłowy klucz API
json
{
  "code": 5002,
  "message": "Invalid API Key",
  "data": null
}
1011 — Błąd parametru
json
{
  "code": 1011,
  "message": "Request parameter error: imageUrl is required",
  "data": null
}
9036 — Obraz nieobsługiwany dla generowania 3D
json
{
  "code": 9036,
  "message": "This image does not support 3D generation",
  "data": null
}
9010 — Nieudane moderowanie treści tekstowej
json
{
  "code": 9010,
  "message": "Text prompt failed content review, contains prohibited content",
  "data": null
}
9051 — Niewystarczające kredyty
json
{
  "code": 9051,
  "message": "Insufficient coins",
  "data": null
}

📄 Pełną listę wspólnych kodów błędów API znajdziesz w Referencji kodów błędów.