Документация API обновления экстерьера#
Базовый URL:
https://api.ideal.house
Версия: v1
Обновлено: 2026-05-20
📖 Обзор#
API обновления экстерьера позволяет обновлять или изменять стиль экстерьера здания по входному изображению. Вы предоставляете исходное изображение и при необходимости добавляете текстовые указания, референсное изображение, стиль здания или предпочтения по окружению для управления результатом обновления.
Рабочий процесс является асинхронным и состоит из двух шагов:
- Создание задачи — Отправьте изображение фасада и необязательные указания, затем получите
taskId. - Опрос результатов — Используйте
taskIdдля запроса статуса задачи и получения сгенерированного изображения.
🔐 Аутентификация#
Все запросы API должны проходить аутентификацию с помощью ключа API.
Укажите ваш ключ API в заголовке запроса:
| Заголовок | Значение |
|---|---|
APIKEY | your_api_key_here |
⚠️ Обеспечьте сохранность вашего ключа API. Не публикуйте его в клиентском коде или публичных репозиториях.
💰 Списание кредитов#
[!WARNING] 🪙 1 кредит списывается при успешном создании задачи. Если задача в итоге завершится ошибкой, списанный кредит будет автоматически возвращён на ваш аккаунт.
При недостатке кредитов возвращается код ошибки9051. 📄 См. Справочник по списанию кредитов.
| Операция | Списанные кредиты |
|---|---|
| Задача обновления экстерьера | 1 кредит |
Подробные правила списания кредитов приведены в Справочнике по списанию кредитов.
📌 Конечные точки API#
1. Создание задачи обновления экстерьера#
Создает новую задачу по обновлению фасада и возвращает уникальный taskId для опроса.
Конечная точка
POST /api/v1/exteriorRenovator/generate
Заголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
APIKEY | ✅ Да | Ваш ключ аутентификации API |
Content-Type | ✅ Да | application/json |
Тело запроса
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
imageUrl | string | ✅ Да | URL исходного изображения фасада для обновления |
prompt | string | ❌ Необязательно | Необязательные текстовые указания для результата обновления |
referenceUrl | string | ❌ Необязательно | Необязательный URL изображения-образца, задающего визуальный стиль |
buildingStyleId | string | ❌ Необязательно | Необязательный идентификатор стиля здания |
environmentId | string | ❌ Необязательно | Необязательный идентификатор стиля окружения или сцены. Поддерживается несколько идентификаторов, разделенных запятой, например id1,id2 |
⚠️ Обязательно только
imageUrl. Все остальные поля тела запроса являются необязательными.
🖼️ Требования к изображениям: Все исходные изображения и изображения-образцы должны быть в формате JPG/JPEG, PNG или WebP. Размер файла не должен превышать 20 МБ, а размеры изображения должны находиться в пределах от 128 × 128 пикс. до 6,000 × 6,000 пикс. (включительно). Перед обработкой изображения, превышающие максимальные размеры в пикселях, автоматически уменьшаются с сохранением пропорций до пределов 6,000 × 6,000 пикс. Изображения по указанным URL должны быть напрямую доступны серверу API.
🎨 Варианты стиля#
buildingStyleId и environmentId можно выбрать из конечной точки Конфигурация стилей API.
Используйте:
GET /api/v1/style/exterior_renovator/getStyles
| Группа стилей | Поле запроса | Описание |
|---|---|---|
buildingStyle | buildingStyleId | Вариант стиля здания |
environment | environmentId | Вариант окружения или сцены. Поддерживается несколько идентификаторов вариантов, разделенных запятой, например id1,id2 |
Каждый вариант содержит name, id и url. Передайте id варианта в соответствующее поле запроса.
📥 Примеры запросов#
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();
📤 Ответ#
Успешный ответ
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Поле | Тип | Описание |
|---|---|---|
code | integer | 0 указывает на успех |
message | string | Сообщение в ответе |
data | long | Уникальный идентификатор задачи для опроса результатов |
2. Получение результата задачи#
Получает текущий статус и результат ранее созданной задачи по обновлению фасада.
Конечная точка
GET /api/v1/exteriorRenovator/result
Заголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
APIKEY | ✅ Да | Ваш ключ аутентификации API |
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
taskId | long | ✅ Да | Идентификатор задачи, возвращенный из конечной точки создания задачи |
📥 Примеры запросов#
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);
📤 Ответ#
Успешный ответ (задача завершена)
{
"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
}
}
}
Ответ (обработка задачи / в очереди)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 50,
"input": {
"imageUrl": "https://example.com/exterior.jpg"
},
"output": null
}
}
Ответ (задача завершилась ошибкой)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/exterior.jpg"
},
"output": null
}
}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id | long | Уникальный идентификатор задачи |
status | string | Текущий статус задачи (см. Статус задачи) |
waitNumber | integer | Количество задач впереди в очереди (0 означает текущую обработку) |
percentage | integer | Процент завершения задачи (0–100) |
input | object | Исходные входные параметры задачи |
input.imageUrl | string | URL исходного изображения фасада |
input.prompt | string | Необязательные текстовые указания, если предоставлены |
input.refImageUrl | string | Необязательный URL изображения-образца, если он предоставлен |
input.buildingStyleId | string | Необязательный идентификатор стиля здания, если предоставлен |
input.environmentId | string | Необязательный идентификатор стиля окружения или сцены, если предоставлен. Может содержать несколько идентификаторов, разделенных запятой |
output | object | Результат генерации (доступен только когда status равно Success) |
output.resultUrl | string | URL изображения с результатом обновления фасада |
output.width | integer | Ширина результата в пикселях |
output.height | integer | Высота результата в пикселях |
📊 Статус задачи#
| Статус | Описание |
|---|---|
Unprocessed | Задача создана, но еще не начата |
Processing | Задача в настоящее время обрабатывается |
Success | Задача успешно завершена — результат доступен |
Failed | Задача не выполнена из-за ошибки |
Опрашивайте каждые 3-5 секунд. См. Лимит задач API.
❌ Ответы об ошибках#
Все ответы об ошибках имеют одинаковую структуру JSON:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
Справочник кодов ошибок#
| Код | Название | Описание | Рекомендуемое действие |
|---|---|---|---|
1001 | FAILED | Запрос не выполнен (общая ошибка) | Проверьте поле message для получения конкретных деталей ошибки |
1003 | INTERNAL_ERROR | Внутренняя ошибка сервера | Повторите попытку после короткой задержки; обратитесь в поддержку, если проблема сохраняется |
1011 | PARAM_ERROR | Ошибка параметров запроса | Убедитесь, что параметры запроса правильно отформатированы |
5002 | API_KEY_INVALID | Недействительный или отсутствующий ключ API | Убедитесь, что заголовок APIKEY присутствует и значение корректно |
9010 | SCAN_TEXT_ERROR | Текстовый запрос не прошёл проверку контента | Удалите из запроса чувствительный или запрещённый контент |
9038 | PROHIBITED_CONTENT | Сгенерированное выходное изображение содержит запрещенный контент | Отрегулируйте промпт/стиль/входные данные и повторите попытку |
9051 | COINS_NOT_ENOUGH | Недостаточно монет / кредитов | Пополните кредиты на вашем аккаунте и повторите попытку. См. Справочник по списанию кредитов |
📄 Для полного списка общих кодов ошибок API см. Справочник кодов ошибок.