Documentazione API di ristrutturazione degli esterni#
URL di base:
https://api.ideal.house
Versione: v1
Aggiornato: 2026-05-20
📖 Panoramica#
API di ristrutturazione degli esterni consente di rinnovare o cambiare lo stile dell'esterno di un edificio a partire da un'immagine. Fornisci un'immagine originale e, facoltativamente, aggiungi indicazioni testuali, un'immagine di riferimento, uno stile architettonico o una preferenza ambientale per orientare il risultato della ristrutturazione.
Il flusso di lavoro è asincrono e prevede due passaggi:
- Crea un'attività — Invia l'immagine dell'esterno e le indicazioni facoltative, quindi ricevi un
taskId. - Interroga periodicamente i risultati — Usa il
taskIdper interrogare lo stato dell'attività e recuperare l'immagine generata.
🔐 Autenticazione#
Tutte le richieste API devono essere autenticate con una chiave API.
Includi la chiave API nell'intestazione della richiesta:
| Intestazione | Valore |
|---|---|
APIKEY | your_api_key_here |
⚠️ Conserva la chiave API in sicurezza. Non esporla nel codice lato client o in repository pubblici.
💰 Detrazione dei crediti#
[!WARNING] 🪙 1 credito viene detratto alla creazione riuscita dell'attività. Se alla fine l'attività non riesce, il credito detratto viene rimborsato automaticamente sul tuo account.
Un saldo di crediti insufficiente restituisce il codice di errore9051. 📄 Consulta il Riferimento delle detrazioni dei crediti.
| Operazione | Crediti detratti |
|---|---|
| Attività di ristrutturazione degli esterni | 1 credito |
Per le regole dettagliate sui crediti, consulta il Riferimento delle detrazioni dei crediti.
📌 Endpoint API#
1. Crea un'attività di ristrutturazione degli esterni#
Crea una nuova attività di ristrutturazione degli esterni e restituisce un taskId univoco per le interrogazioni periodiche.
Endpoint
POST /api/v1/exteriorRenovator/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 dell'esterno da ristrutturare |
prompt | string | ❌ Facoltativo | Indicazioni testuali facoltative per il risultato della ristrutturazione |
referenceUrl | string | ❌ Facoltativo | URL facoltativa di un'immagine di riferimento per orientare lo stile visivo |
buildingStyleId | string | ❌ Facoltativo | Identificatore facoltativo dello stile architettonico |
environmentId | string | ❌ Facoltativo | Identificatore facoltativo dello stile dell'ambiente o della scena. Supporta più identificatori uniti da virgole, ad esempio id1,id2 |
⚠️ Soltanto
imageUrlè obbligatorio. Tutti gli altri campi del corpo della richiesta 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.
🎨 Opzioni di stile#
buildingStyleId e environmentId possono essere selezionati dall'endpoint Configurazione degli stili API.
Usa:
GET /api/v1/style/exterior_renovator/getStyles
| Gruppo di stile | Campo della richiesta | Descrizione |
|---|---|---|
buildingStyle | buildingStyleId | Opzione dello stile architettonico |
environment | environmentId | Opzione dell'ambiente o della scena. Supporta più identificatori di opzione uniti da virgole, ad esempio id1,id2 |
Ogni opzione contiene name, id e url. Passa l'id dell'opzione nel campo corrispondente della richiesta.
📥 Esempi di richiesta#
cURL
# Minimal request
curl -X POST "https://api.ideal.house/api/v1/exteriorRenovator/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/exterior.jpg"
}'
# Request with optional guidance
curl -X POST "https://api.ideal.house/api/v1/exteriorRenovator/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/exterior.jpg",
"prompt": "Modern farmhouse exterior with warm wood accents, black window frames, and clean landscaping",
"referenceUrl": "https://example.com/reference-house.jpg",
"buildingStyleId": "modern-farmhouse",
"environmentId": "Architecture_Enviroment_Time_Night,Architecture_Enviroment_Time_Day"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class ExteriorRenovatorApiExample {
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/exterior.jpg",
"prompt": "Modern farmhouse exterior with warm wood accents, black window frames, and clean landscaping",
"referenceUrl": "https://example.com/reference-house.jpg",
"buildingStyleId": "modern-farmhouse",
"environmentId": "Architecture_Enviroment_Time_Night,Architecture_Enviroment_Time_Day"
}
""";
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/exteriorRenovator/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/exterior.jpg",
"prompt": "Modern farmhouse exterior with warm wood accents, black window frames, and clean landscaping",
"referenceUrl": "https://example.com/reference-house.jpg",
"buildingStyleId": "modern-farmhouse",
"environmentId": "Architecture_Enviroment_Time_Night,Architecture_Enviroment_Time_Day"
}
response = requests.post(
f"{BASE_URL}/api/v1/exteriorRenovator/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 createExteriorRenovatorTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/exteriorRenovator/generate`,
{
imageUrl: 'https://example.com/exterior.jpg',
prompt: 'Modern farmhouse exterior with warm wood accents, black window frames, and clean landscaping',
referenceUrl: 'https://example.com/reference-house.jpg',
buildingStyleId: 'modern-farmhouse',
environmentId: 'Architecture_Enviroment_Time_Night,Architecture_Enviroment_Time_Day'
},
{
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);
}
}
createExteriorRenovatorTask();
📤 Risposta#
Risposta di successo
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Campo | Tipo | Descrizione |
|---|---|---|
code | integer | 0 indica il successo |
message | string | Messaggio della risposta |
data | long | Identificatore univoco dell'attività per interrogare periodicamente i risultati |
2. Ottieni il risultato dell'attività#
Recupera lo stato e l'output correnti di un'attività di ristrutturazione degli esterni creata in precedenza.
Endpoint
GET /api/v1/exteriorRenovator/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 dell'attività |
📥 Esempi di richiesta#
cURL
curl -X GET "https://api.ideal.house/api/v1/exteriorRenovator/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class ExteriorRenovatorResultExample {
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/exteriorRenovator/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/exteriorRenovator/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 failed")
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/exteriorRenovator/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 failed');
}
break;
}
await new Promise(resolve => setTimeout(resolve, 3000));
}
}
pollResult(1234567890123456789);
📤 Risposta#
Risposta di successo (attività completata)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/exterior.jpg",
"prompt": "Modern farmhouse exterior with warm wood accents, black window frames, and clean landscaping",
"refImageUrl": "https://example.com/reference-house.jpg",
"buildingStyleId": "modern-farmhouse",
"environmentId": "Architecture_Enviroment_Time_Night,Architecture_Enviroment_Time_Day"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/exterior_renovator_result.jpg",
"width": 1024,
"height": 1024
}
}
}
Risposta (attività in elaborazione / in coda)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 50,
"input": {
"imageUrl": "https://example.com/exterior.jpg"
},
"output": null
}
}
Risposta (attività non riuscita)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/exterior.jpg"
},
"output": null
}
}
Campi della risposta
| Campo | Tipo | Descrizione |
|---|---|---|
id | long | Identificatore univoco dell'attività |
status | string | Stato corrente dell'attività (vedi Stato dell'attività) |
waitNumber | integer | Numero di attività precedenti in coda (0 significa attualmente in elaborazione) |
percentage | integer | Percentuale di completamento dell'attività (0–100) |
input | object | Parametri di input originali dell'attività |
input.imageUrl | string | URL dell'immagine originale dell'esterno |
input.prompt | string | Indicazioni testuali facoltative, se fornite |
input.refImageUrl | string | URL facoltativa dell'immagine di riferimento, se fornita |
input.buildingStyleId | string | Identificatore facoltativo dello stile architettonico, se fornito |
input.environmentId | string | Identificatore facoltativo dello stile dell'ambiente o della scena, se fornito. Può contenere più identificatori uniti da virgole |
output | object | Risultato della generazione (disponibile soltanto quando status è Success) |
output.resultUrl | string | URL dell'immagine risultante dalla ristrutturazione degli esterni |
output.width | integer | Larghezza dell'output in pixel |
output.height | integer | Altezza dell'output in pixel |
📊 Stato dell'attività#
| Stato | Descrizione |
|---|---|
Unprocessed | L'attività è stata creata ma non è ancora iniziata |
Processing | L'attività è attualmente in elaborazione |
Success | L'attività è stata completata correttamente — l'output è disponibile |
Failed | L'attività non è riuscita a causa di un errore |
Interroga lo stato ogni 3-5 secondi. Consulta i Limiti delle attività API.
❌ Risposte di errore#
Tutte le risposte di errore condividono la stessa struttura JSON:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
Riferimento dei codici di errore#
| Codice | Nome | Descrizione | Azione suggerita |
|---|---|---|---|
1001 | FAILED | Richiesta non riuscita (errore generico) | Controlla il campo message per i dettagli specifici dell'errore |
1003 | INTERNAL_ERROR | Errore interno del server | Riprova dopo una breve attesa; contatta l'assistenza se il problema persiste |
1011 | PARAM_ERROR | Errore nei parametri della richiesta | Assicurati che i parametri della richiesta siano formattati correttamente |
5002 | API_KEY_INVALID | Chiave API non valida o mancante | Assicurati che l'intestazione APIKEY sia presente e che il valore sia corretto |
9010 | SCAN_TEXT_ERROR | Il prompt testuale non ha superato la verifica dei contenuti | Modifica il prompt per rimuovere eventuali contenuti sensibili o vietati |
9038 | PROHIBITED_CONTENT | L'immagine generata contiene contenuti vietati | Modifica prompt/stile/input e riprova |
9051 | COINS_NOT_ENOUGH | Monete / crediti insufficienti | Ricarica i crediti dell'account e riprova. Consulta il Riferimento delle detrazioni dei crediti |
📄 Per l'elenco completo dei codici di errore API comuni, consulta il Riferimento dei codici di errore.