Documentazione API di visualizzazione delle planimetrie#
URL di base:
https://api.ideal.house
Versione: v1
Aggiornato: 2026-05-21
📖 Panoramica#
API di visualizzazione delle planimetrie trasforma l'immagine di una pianta in una visualizzazione generata dall'intelligenza artificiale. Supporta indicazioni testuali facoltative, tipo di pianta, stile visivo, opzioni di vista e modalità del modello.
Il flusso di lavoro è asincrono:
- Crea un'attività — Invia
imageUrle i parametri facoltativi, quindi ricevi untaskId. - Interroga periodicamente i risultati — Usa
taskIdper recuperare lo stato dell'attività e l'immagine generata.
🔐 Autenticazione#
| Intestazione | Valore |
|---|---|
APIKEY | your_api_key_here |
💰 Detrazione dei crediti#
[!WARNING] I crediti vengono detratti quando un'attività viene creata correttamente. Se alla fine l'attività non riesce, i crediti detratti vengono rimborsati automaticamente.
Un saldo di crediti insufficiente restituisce il codice di errore9051. Consulta il Riferimento delle detrazioni dei crediti.
Modello (modelType) | Crediti detratti |
|---|---|
Base | 3 crediti |
Pro | 10 crediti |
Se modelType non viene fornito, viene usato Base per impostazione predefinita.
🎨 Opzioni di stile#
Questa API supporta parametri di stile facoltativi restituiti dall'endpoint Configurazione degli stili API.
Usa:
GET /api/v1/style/ai_plan_visualizer/getStyles
| Gruppo di stile | Campo della richiesta | Descrizione |
|---|---|---|
planType | planStyleId | Opzione del tipo di pianta |
style | styleId | Opzione dello stile di visualizzazione |
view | viewId | Opzione della fotocamera/vista |
Ogni opzione contiene name, id e url. Passa l'id dell'opzione nel campo corrispondente della richiesta.
📌 Endpoint API#
1. Crea un'attività di visualizzazione di una planimetria#
Endpoint
POST /api/v1/planVisualizer/generate
Intestazioni della richiesta
| Intestazione | Obbligatoria | Descrizione |
|---|---|---|
APIKEY | ✅ Sì | La tua chiave di autenticazione API |
Content-Type | ✅ Sì | application/json |
Corpo della richiesta
| Campo | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
imageUrl | string | ✅ Sì | URL dell'immagine originale della pianta |
prompt | string | ❌ Facoltativo | Indicazioni testuali per la visualizzazione desiderata |
planStyleId | string | ❌ Facoltativo | Identificatore del tipo di pianta dalle opzioni di stile planType |
styleId | string | ❌ Facoltativo | Identificatore dello stile di visualizzazione dalle opzioni di stile style |
viewId | string | ❌ Facoltativo | Identificatore della vista dalle opzioni di stile view |
modelType | string | ❌ Facoltativo | Enumerazione: Base, Pro. Valore predefinito: Base |
Soltanto
imageUrlè obbligatorio. Tutti gli altri campi sono facoltativi.
🖼️ Requisiti delle immagini: tutte le immagini originali e di riferimento devono usare JPG/JPEG, PNG o WebP. Ogni immagine non deve superare 20 MB, con dimensioni da 128 × 128 px fino a 6,000 × 6,000 px (estremi inclusi). Prima dell'elaborazione, le immagini che superano le dimensioni massime in pixel vengono ridotte automaticamente in modo proporzionale per rientrare in 6,000 × 6,000 px. Le URLs delle immagini devono essere direttamente accessibili dal server API.
📥 Esempi di richiesta#
cURL
curl -X POST "https://api.ideal.house/api/v1/planVisualizer/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/floor-plan.jpg",
"prompt": "bright modern residential visualization",
"planStyleId": "AI plan visualizer_Plan type_Master plan",
"styleId": "AI plan visualizer_Style_Marker pen",
"viewId": "AI plan visualizer_View_Top-Down View",
"modelType": "Base"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class PlanVisualizerApiExample {
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/floor-plan.jpg",
"prompt": "bright modern residential visualization",
"planStyleId": "AI plan visualizer_Plan type_Master plan",
"styleId": "AI plan visualizer_Style_Marker pen",
"viewId": "AI plan visualizer_View_Top-Down View",
"modelType": "Base"
}
""";
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/planVisualizer/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"
}
payload = {
"imageUrl": "https://example.com/floor-plan.jpg",
"prompt": "bright modern residential visualization",
"planStyleId": "AI plan visualizer_Plan type_Master plan",
"styleId": "AI plan visualizer_Style_Marker pen",
"viewId": "AI plan visualizer_View_Top-Down View",
"modelType": "Base"
}
response = requests.post(
f"{BASE_URL}/api/v1/planVisualizer/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 createPlanVisualizerTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/planVisualizer/generate`,
{
imageUrl: 'https://example.com/floor-plan.jpg',
prompt: 'bright modern residential visualization',
planStyleId: 'AI plan visualizer_Plan type_Master plan',
styleId: 'AI plan visualizer_Style_Marker pen',
viewId: 'AI plan visualizer_View_Top-Down View',
modelType: 'Base'
},
{
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);
}
}
createPlanVisualizerTask();
📤 Risposta#
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
2. Ottieni il risultato dell'attività#
Endpoint
GET /api/v1/planVisualizer/result
Intestazioni della richiesta
| Intestazione | Obbligatoria | Descrizione |
|---|---|---|
APIKEY | ✅ Sì | La tua chiave di autenticazione API |
Parametri di interrogazione
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
taskId | long | ✅ Sì | Identificatore dell'attività restituito dall'endpoint di creazione |
📥 Esempi di richiesta#
cURL
curl -X GET "https://api.ideal.house/api/v1/planVisualizer/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class PlanVisualizerResultExample {
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/planVisualizer/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
while True:
response = requests.get(
f"{BASE_URL}/api/v1/planVisualizer/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)
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 pollPlanVisualizerResult(taskId) {
const headers = { APIKEY: API_KEY };
while (true) {
const response = await axios.get(
`${BASE_URL}/api/v1/planVisualizer/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;
}
await new Promise(resolve => setTimeout(resolve, 3000));
}
}
pollPlanVisualizerResult(1234567890123456789n);
📤 Esempio di risposta#
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/floor-plan.jpg",
"prompt": "bright modern residential visualization",
"planStyleId": "AI plan visualizer_Plan type_Master plan",
"styleId": "AI plan visualizer_Style_Marker pen",
"viewId": "AI plan visualizer_View_Top-Down View",
"modelType": "Base"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/plan_visualizer_result.jpg",
"width": 1024,
"height": 1024
}
}
}
Risposta (attività in elaborazione / in coda)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 45,
"input": {
"imageUrl": "https://example.com/floor-plan.jpg",
"modelType": "Base"
},
"output": null
}
}
Risposta (attività non riuscita)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/floor-plan.jpg",
"modelType": "Base"
},
"output": null
}
}
📊 Stato dell'attività#
| Stato | Descrizione |
|---|---|
Unprocessed | L'attività è stata creata ed è in attesa in coda |
Processing | L'attività è attualmente in esecuzione |
Success | L'attività è stata completata correttamente |
Failed | L'attività non è riuscita e non è stato prodotto alcun output |
Interroga lo stato ogni 3-5 secondi. Consulta i Limiti delle attività API.
❌ Risposte di errore#
| Codice | Nome | Descrizione |
|---|---|---|
1011 | PARAM_ERROR | Errore nei parametri della richiesta |
5002 | API_KEY_INVALID | Chiave API non valida o mancante |
9010 | SCAN_TEXT_ERROR | Il prompt non ha superato la verifica dei contenuti |
9038 | PROHIBITED_CONTENT | L'immagine generata contiene contenuti vietati |
9051 | COINS_NOT_ENOUGH | Crediti insufficienti |
Per le definizioni complete degli errori comuni, consulta il Riferimento dei codici di errore.