Dokumentacja API Renowacji Elewacji#
Podstawowy URL:
https://api.ideal.house
Wersja: v1
Zaktualizowano: 2026-05-20
📖 Przegląd#
API Renowacji Elewacji umożliwia renowację lub zmianę stylu elewacji budynku na podstawie obrazu wejściowego. Przesyłasz obraz źródłowy, a opcjonalnie dodajesz wskazówki tekstowe, obraz referencyjny, styl budynku lub preferencje środowiskowe, aby sterować wynikiem renowacji.
Przepływ pracy jest asynchroniczny i obejmuje dwa kroki:
- Utwórz zadanie — Prześlij swój obraz elewacji i opcjonalne wskazówki, a następnie otrzymaj
taskId. - Sprawdzaj wyniki — Użyj
taskId, aby zapytać o status zadania i pobrać wygenerowany obraz.
🔐 Uwierzytelnianie#
Wszystkie żądania API muszą być uwierzytelniane za pomocą klucza API.
Włącz swój klucz API Key w nagłówku żądania:
| Nagłówek | Wartość |
|---|---|
APIKEY | your_api_key_here |
⚠️ Zachowaj klucz API w tajemnicy. Nie ujawniaj go w kodzie po stronie klienta ani w publicznych repozytoriach.
💰 Odejmowanie kredytów#
[!WARNING] 🪙 1 kredyt jest odejmowany po pomyślnym utworzeniu zadania. Jeśli zadanie ostatecznie zawiedzie, odejęty kredyt zostanie automatycznie zwrócony na Twoje konto.
Niewystarczające kredyty spowodują zwrócenie kodu błędu9051. 📄 Zobacz Referencja odejmowania kredytów.
| Operacja | Odejęte kredyty |
|---|---|
| Zadanie Renowacji Elewacji | 1 kredyt |
Szczegółowe zasady dotyczące kredytów znajdziesz w Referencji odejmowania kredytów.
📌 Endpoints API#
1. Utwórz zadanie Renowacji Elewacji#
Tworzy nowe zadanie renowacji elewacji i zwraca unikalny taskId do sprawdzania wyników.
Endpoint
POST /api/v1/exteriorRenovator/generate
Nagłówki żądania
| Nagłówek | Wymagany | Opis |
|---|---|---|
APIKEY | ✅ Tak | Twój klucz uwierzytelniający API |
Content-Type | ✅ Tak | application/json |
Ciało żądania
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
imageUrl | string | ✅ Tak | URL źródłowego obrazu elewacji do renowacji |
prompt | string | ❌ Opcjonalnie | Opcjonalna wskazówka tekstowa dla wyniku renowacji |
referenceUrl | string | ❌ Opcjonalnie | Opcjonalny URL obrazu referencyjnego do sterowania stylem wizualnym |
buildingStyleId | string | ❌ Opcjonalnie | Opcjonalny identyfikator stylu budynku |
environmentId | string | ❌ Opcjonalnie | Opcjonalny identyfikator stylu środowiska lub sceny. Obsługuje wiele identyfikatorów połączonych przecinkiem, na przykład id1,id2 |
⚠️ Wymagane jest tylko
imageUrl. Wszystkie inne pola w ciele żądania są opcjonalne.
🖼️ Wymagania dotyczące obrazów: Wszystkie obrazy źródłowe i referencyjne muszą być w formacie 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 przedziale od 128 × 128 px do 6,000 × 6,000 px (włącznie). Obrazy przekraczające maksymalne wymiary pikseli są automatycznie skalowane proporcjonalnie, aby zmieściły się w granicach 6,000 × 6,000 px przed przetwarzaniem. Adresy URL obrazów muszą być bezpośrednio dostępne dla serwera API.
🎨 Opcje stylu#
buildingStyleId i environmentId można wybrać z endpointu API Konfiguracja stylu.
Użyj:
GET /api/v1/style/exterior_renovator/getStyles
| Grupa stylu | Pole żądania | Opis |
|---|---|---|
buildingStyle | buildingStyleId | Opcja stylu budynku |
environment | environmentId | Opcja środowiska lub sceny. Obsługuje wiele identyfikatorów opcji połączonych przecinkiem, na przykład id1,id2 |
Każda opcja zawiera name, id i url. Prześlij identyfikator opcji id do odpowiedniego pola żądania.
📥 Przykłady żądań#
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();
📤 Odpowiedź#
Odpowiedź sukcesu
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Pole | Typ | Opis |
|---|---|---|
code | integer | 0 oznacza sukces |
message | string | Komunikat odpowiedzi |
data | long | Unikalny identyfikator zadania do sprawdzania wyników |
2. Pobierz wynik zadania#
Pobiera bieżący status i wynik wcześniej utworzonego zadania renowacji elewacji.
Endpoint
GET /api/v1/exteriorRenovator/result
Nagłówki żądania
| Nagłówek | Wymagany | Opis |
|---|---|---|
APIKEY | ✅ Tak | Twój klucz uwierzytelniający API |
Parametry zapytania
| Parametr | Typ | Wymagany | Opis |
|---|---|---|---|
taskId | long | ✅ Tak | Identyfikator zadania zwrócony z endpointu tworzenia zadania |
📥 Przykłady żądań#
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);
📤 Odpowiedź#
Odpowiedź sukcesu (Zadanie zakończone)
{
"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
}
}
}
Odpowiedź (Zadanie w trakcie przetwarzania / W kolejce)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 50,
"input": {
"imageUrl": "https://example.com/exterior.jpg"
},
"output": null
}
}
Odpowiedź (Zadanie nie powiodło się)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/exterior.jpg"
},
"output": null
}
}
Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
id | long | Unikalny identyfikator zadania |
status | string | Bieżący status zadania (zobacz Status zadania) |
waitNumber | integer | Liczba zadań przed Tobą w kolejce (0 oznacza, że zadanie jest obecnie przetwarzane) |
percentage | integer | Procent ukończenia zadania (0–100) |
input | object | Oryginalne parametry wejściowe zadania |
input.imageUrl | string | URL źródłowego obrazu elewacji |
input.prompt | string | Opcjonalna wskazówka tekstowa, jeśli została podana |
input.refImageUrl | string | Opcjonalny URL obrazu referencyjnego, jeśli został podany |
input.buildingStyleId | string | Opcjonalny identyfikator stylu budynku, jeśli został podany |
input.environmentId | string | Opcjonalny identyfikator stylu środowiska lub sceny, jeśli został podany. Może zawierać wiele identyfikatorów połączonych przecinkiem |
output | object | Wynik generacji (dostępny tylko, gdy status wynosi Success) |
output.resultUrl | string | URL do obrazu wyniku renowacji elewacji |
output.width | integer | Szerokość wyjściowa w pikselach |
output.height | integer | Wysokość wyjściowa w pikselach |
📊 Status zadania#
| Status | Opis |
|---|---|
Unprocessed | Zadanie zostało utworzone, ale nie zostało jeszcze rozpoczęte |
Processing | Zadanie jest obecnie przetwarzane |
Success | Zadanie zakończyło się pomyślnie — wynik jest dostępny |
Failed | Zadanie nie powiodło się z powodu błędu |
Wykonuj cykliczne sprawdzanie stanu co 3-5 sekund. Zobacz Limit zadań API.
❌ Odpowiedzi błędów#
Wszystkie odpowiedzi błędów mają tę samą strukturę JSON:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
Referencja kodów błędów#
| Kod | Nazwa | Opis | Sugerowane działanie |
|---|---|---|---|
1001 | FAILED | Żądanie nie powiodło się (błąd ogólny) | Sprawdź pole message, aby uzyskać szczegółowe informacje o błędzie |
1003 | INTERNAL_ERROR | Wewnętrzny błąd serwera | Ponów próbę po krótkim opóźnieniu; skontaktuj się z pomocą techniczną, jeśli problem utrzymuje się |
1011 | PARAM_ERROR | Błąd parametru żądania | Upewnij się, że parametry żądania są poprawnie sformatowane |
5002 | API_KEY_INVALID | Nieprawidłowy lub brakujący klucz API | Upewnij się, że nagłówek APIKEY jest obecny i ma poprawną wartość |
9010 | SCAN_TEXT_ERROR | Wskazówka tekstowa nie przeszła weryfikacji treści | Zmodyfikuj wskazówkę, aby usunąć wszelkie treści wrażliwe lub zakazane |
9038 | PROHIBITED_CONTENT | Wygenerowany obraz wyjściowy zawiera treści zakazane | Dostosuj wskazówkę/styl/wejścia i ponów próbę |
9051 | COINS_NOT_ENOUGH | Niewystarczające monety / kredyty | Doładuj kredyty na swoim koncie i ponów próbę. Zobacz Referencja odejmowania kredytów |
📄 Pełną listę wspólnych kodów błędów API znajdziesz w Referencji kodów błędów.