Документация API по декорированию интерьера#
Базовый URL:
https://api.ideal.house
Версия: v1
Обновлено: 2026-05-21
📖 Обзор#
API по декорированию интерьера генерирует идеи оформления для изображения интерьера. Поддерживаются необязательные текстовые указания, референсное изображение, выбор стиля и режимы моделей.
Рабочий процесс является асинхронным:
- Создание задачи — Отправьте
imageUrlи необязательные параметры, затем получитеtaskId. - Опрос результатов — Используйте
taskIdдля получения статуса задачи и сгенерированного изображения.
🔐 Аутентификация#
| Заголовок | Значение |
|---|---|
APIKEY | your_api_key_here |
💰 Списание кредитов#
[!WARNING] Кредиты списываются при успешном создании задачи. Если задача в итоге завершится ошибкой, списанные кредиты будут автоматически возвращены.
При недостатке кредитов возвращается код ошибки9051. См. Справочник по списанию кредитов.
Модель (modelType) | Списанные кредиты |
|---|---|
Base | 3 кредита |
Pro | 10 кредитов |
Если modelType не предоставлен, по умолчанию используется Base.
🎨 Варианты стиля#
Этот API поддерживает необязательные параметры стиля, возвращаемые конечной точкой Конфигурация стилей API.
Используйте:
GET /api/v1/style/home_decor_ideas/getStyles
| Группа стилей | Поле запроса | Описание |
|---|---|---|
spaceType | spaceStyleId | Вариант типа пространства или комнаты |
decorStyle | homeDecorStyleId | Вариант стиля оформления |
Каждый вариант содержит name, id и url. Передайте id варианта в соответствующее поле запроса.
📌 Конечные точки API#
1. Создание задачи декорирования интерьера#
Конечная точка
POST /api/v1/homeDecor/generate
Заголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
APIKEY | ✅ Да | Ваш ключ аутентификации API |
Content-Type | ✅ Да | application/json |
Тело запроса
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
imageUrl | string | ✅ Да | URL исходного интерьерного изображения |
referenceUrl | string | ❌ Необязательно | URL референсного изображения для указания стиля оформления |
spaceStyleId | string | ❌ Необязательно | Идентификатор типа пространства из вариантов стиля spaceType |
homeDecorStyleId | string | ❌ Необязательно | Идентификатор стиля оформления из вариантов стиля decorStyle |
prompt | string | ❌ Необязательно | Текстовые указания для желаемого результата |
modelType | string | ❌ Необязательно | Перечисление: Base, Pro. По умолчанию: Base |
Обязательно только
imageUrl. Все остальные поля являются необязательными.
🖼️ Требования к изображениям: Все исходные изображения и изображения-образцы должны быть в формате JPG/JPEG, PNG или WebP. Размер файла не должен превышать 20 МБ, а размеры изображения должны находиться в пределах от 128 × 128 пикс. до 6,000 × 6,000 пикс. (включительно). Перед обработкой изображения, превышающие максимальные размеры в пикселях, автоматически уменьшаются с сохранением пропорций до пределов 6,000 × 6,000 пикс. Изображения по указанным URL должны быть напрямую доступны серверу API.
📥 Примеры запросов#
cURL
curl -X POST "https://api.ideal.house/api/v1/homeDecor/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"referenceUrl": "https://example.com/reference.jpg",
"spaceStyleId": "Indoor_Living Room",
"homeDecorStyleId": "Holidays_Cozy Christmas",
"prompt": "warm seasonal decor with natural textures",
"modelType": "Base"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class HomeDecorApiExample {
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",
"referenceUrl": "https://example.com/reference.jpg",
"spaceStyleId": "Indoor_Living Room",
"homeDecorStyleId": "Holidays_Cozy Christmas",
"prompt": "warm seasonal decor with natural textures",
"modelType": "Base"
}
""";
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/homeDecor/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/room.jpg",
"referenceUrl": "https://example.com/reference.jpg",
"spaceStyleId": "Indoor_Living Room",
"homeDecorStyleId": "Holidays_Cozy Christmas",
"prompt": "warm seasonal decor with natural textures",
"modelType": "Base"
}
response = requests.post(
f"{BASE_URL}/api/v1/homeDecor/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 createHomeDecorTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/homeDecor/generate`,
{
imageUrl: 'https://example.com/room.jpg',
referenceUrl: 'https://example.com/reference.jpg',
spaceStyleId: 'Indoor_Living Room',
homeDecorStyleId: 'Holidays_Cozy Christmas',
prompt: 'warm seasonal decor with natural textures',
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);
}
}
createHomeDecorTask();
📤 Ответ#
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
2. Получение результата задачи#
Конечная точка
GET /api/v1/homeDecor/result
Заголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
APIKEY | ✅ Да | Ваш ключ аутентификации API |
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
taskId | long | ✅ Обязательно | Идентификатор задачи, возвращенный конечной точкой создания |
📥 Примеры запросов#
cURL
curl -X GET "https://api.ideal.house/api/v1/homeDecor/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class HomeDecorResultExample {
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/homeDecor/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/homeDecor/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 pollHomeDecorResult(taskId) {
const headers = { APIKEY: API_KEY };
while (true) {
const response = await axios.get(
`${BASE_URL}/api/v1/homeDecor/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));
}
}
pollHomeDecorResult(1234567890123456789n);
📤 Пример ответа#
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/room.jpg",
"refImageUrl": "https://example.com/reference.jpg",
"spaceStyleId": "Indoor_Living Room",
"homeDecorStyleId": "Holidays_Cozy Christmas",
"prompt": "warm seasonal decor with natural textures",
"modelType": "Base"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/home_decor_result.jpg",
"width": 1024,
"height": 1024
}
}
}
Ответ (обработка задачи / в очереди)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 45,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Base"
},
"output": null
}
}
Ответ (задача завершилась ошибкой)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Base"
},
"output": null
}
}
📊 Статус задачи#
| Статус | Описание |
|---|---|
Unprocessed | Задача создана и ожидает в очереди |
Processing | Задача в настоящее время выполняется |
Success | Задача успешно завершена |
Failed | Задача завершилась ошибкой, результат не создан |
Опрашивайте каждые 3-5 секунд. См. Лимит задач API.
❌ Ответы об ошибках#
| Код | Название | Описание |
|---|---|---|
1011 | PARAM_ERROR | Ошибка параметров запроса |
5002 | API_KEY_INVALID | Недействительный или отсутствующий ключ API |
9010 | SCAN_TEXT_ERROR | Промпт не прошел проверку контента |
9038 | PROHIBITED_CONTENT | Сгенерированное изображение содержит запрещенный контент |
9051 | COINS_NOT_ENOUGH | Недостаточно кредитов |
Полные описания общих ошибок приведены в Справочнике кодов ошибок.