Документация API примерки мебели#
Базовый URL:
https://api.ideal.house
Версия: v1
Обновлено: 2026-03-09
📖 Обзор#
API примерки мебели позволяет виртуально размещать мебель в комнате с помощью ИИ. Вы передаёте изображение комнаты и список предметов мебели, каждый с изображением и идентификатором товара, а ИИ естественно встраивает мебель в сцену. Процесс асинхронный и состоит из двух шагов:
- Создание задачи — Отправьте изображение комнаты и список мебели, затем получите
taskId. - Опрос результатов — Используйте
taskIdдля запроса статуса задачи и получения сгенерированного изображения.
📌 Примечание: В настоящее время поддерживается только режим
creative.
🔐 Аутентификация#
Все запросы API должны проходить аутентификацию с помощью ключа API.
Укажите ваш ключ API в заголовке запроса:
| Заголовок | Значение |
|---|---|
APIKEY | your_api_key_here |
⚠️ Держите ваш ключ API в тайне. Не публикуйте его в клиентском коде или публичных репозиториях.
💰 Списание кредитов#
[!WARNING] 🪙 При успешном создании задачи кредиты списываются в зависимости от выбранного
modelType. Если задача в итоге завершится ошибкой, списанные кредиты будут автоматически возвращены на ваш аккаунт.
При недостатке кредитов возвращается код ошибки9051. 📄 См. Справочник по списанию кредитов.
Модель (modelType) | Списанные кредиты |
|---|---|
Base | 3 кредита |
Pro | 10 кредитов |
📌 Конечные точки API#
1. Создание задачи примерки мебели#
Создает новую задачу примерки мебели с помощью ИИ и возвращает уникальный taskId для опроса.
Конечная точка
POST /api/v1/furnitureTryOn/generate
Заголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
APIKEY | ✅ Да | Ваш ключ аутентификации API |
Content-Type | ✅ Да | application/json |
Тело запроса
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
imageUrl | string | ✅ Да | URL изображения комнаты, в которой будет размещена мебель |
furnitureList | array | ✅ Да | Список предметов мебели для размещения в сцене. Максимум 6 элементов. См. Объект предмета мебели |
prompt | string | ❌ Необязательно | Пользовательский текстовый промпт для дополнительного управления размещением и стилем |
modelType | string | ❌ Необязательно | Тип качества модели. Перечисление: Base, Pro. По умолчанию: Base |
🛋️ Объект предмета мебели#
Каждый элемент в furnitureList должен быть объектом со следующими полями:
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
imageUrl | string | ✅ Да | URL изображения предмета мебели; рекомендуется прозрачный или нейтральный фон |
⚠️
furnitureListможет содержать не более 6 элементов.
🖼️ Требования к изображениям: Изображение комнаты и каждое изображение мебели должны быть в формате JPG/JPEG, PNG или WebP. Размер файла не должен превышать 20 МБ, а размеры изображения должны находиться в пределах от 128 × 128 px до 6,000 × 6,000 px (включительно). Перед обработкой изображения, превышающие максимальные размеры в пикселях, автоматически уменьшаются с сохранением пропорций до пределов 6,000 × 6,000 px. Изображения по указанным URL должны быть напрямую доступны серверу API.
Пример
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
},
{
"imageUrl": "https://example.com/table.png"
}
]
Типы моделей
| Значение | Описание |
|---|---|
Base | По умолчанию. Сбалансированная скорость и качество |
Pro | Более высокое качество вывода, более медленная обработка |
📥 Примеры запросов#
cURL
# Basic request (Base model)
curl -X POST "https://api.ideal.house/api/v1/furnitureTryOn/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
},
{
"imageUrl": "https://example.com/coffee-table.png"
}
],
"prompt": "modern minimalist style"
}'
# Pro model
curl -X POST "https://api.ideal.house/api/v1/furnitureTryOn/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
}
],
"prompt": "Scandinavian interior with warm lighting",
"modelType": "Pro"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class FurnitureTryOnApiExample {
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/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
},
{
"imageUrl": "https://example.com/coffee-table.png"
}
],
"prompt": "modern minimalist style",
"modelType": "Base"
}
""";
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/furnitureTryOn/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/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
},
{
"imageUrl": "https://example.com/coffee-table.png"
}
],
"prompt": "modern minimalist style",
"modelType": "Base"
}
# Pro model example:
# payload = {
# "imageUrl": "https://example.com/living-room.jpg",
# "furnitureList": [
# {
# "imageUrl": "https://example.com/sofa.png"
# }
# ],
# "prompt": "Scandinavian interior with warm lighting",
# "modelType": "Pro"
# }
response = requests.post(
f"{BASE_URL}/api/v1/furnitureTryOn/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 createFurnitureTryOnTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/furnitureTryOn/generate`,
{
imageUrl: 'https://example.com/living-room.jpg',
furnitureList: [
{
imageUrl: 'https://example.com/sofa.png'
},
{
imageUrl: 'https://example.com/coffee-table.png'
}
],
prompt: 'modern minimalist style',
modelType: 'Base'
// Pro model:
// modelType: 'Pro'
},
{
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);
}
}
createFurnitureTryOnTask();
📤 Ответ#
Успешный ответ
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Поле | Тип | Описание |
|---|---|---|
code | integer | 0 указывает на успех |
message | string | Сообщение в ответе |
data | long | Уникальный идентификатор задачи для опроса результатов |
2. Получение результата задачи#
Получает текущий статус и результат ранее созданной задачи примерки мебели.
Конечная точка
GET /api/v1/furnitureTryOn/result
Заголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
APIKEY | ✅ Да | Ваш ключ аутентификации API |
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
taskId | long | ✅ Да | Идентификатор задачи, возвращенный из конечной точки создания задачи |
📥 Примеры запросов#
cURL
curl -X GET "https://api.ideal.house/api/v1/furnitureTryOn/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class FurnitureTryOnResultExample {
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/furnitureTryOn/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
# Poll until task is complete
while True:
response = requests.get(
f"{BASE_URL}/api/v1/furnitureTryOn/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) # Poll every 3 seconds
if status == "Success":
output = result["output"]
print("Result URL:", output["resultUrl"])
print("Matched Items:", output.get("items", []))
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 pollResult(taskId) {
const headers = { 'APIKEY': API_KEY };
while (true) {
const response = await axios.get(
`${BASE_URL}/api/v1/furnitureTryOn/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('Matched Items:', result.output.items);
} else {
console.log('Task ended with status:', status);
}
break;
}
// Wait 3 seconds before next poll
await new Promise(resolve => setTimeout(resolve, 3000));
}
}
pollResult(1234567890123456789n);
📤 Ответ#
Успешный ответ (задача завершена)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
},
{
"imageUrl": "https://example.com/coffee-table.png"
}
],
"prompt": "modern minimalist style",
"modelType": "Base"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/furniture_try_on_result.jpg",
"width": 1024,
"height": 1024
}
}
}
Ответ (обработка задачи / в очереди)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 45,
"input": {
"imageUrl": "https://example.com/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
}
],
"prompt": "modern minimalist style",
"modelType": "Base"
},
"output": null
}
}
Ответ (задача завершилась ошибкой)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/living-room.jpg",
"furnitureList": [
{
"imageUrl": "https://example.com/sofa.png"
}
],
"modelType": "Base"
},
"output": null
}
}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id | long | Уникальный идентификатор задачи |
status | string | Текущий статус задачи (см. Статус задачи) |
waitNumber | integer | Количество задач впереди в очереди (0 означает текущую обработку) |
percentage | integer | Процент завершения задачи (0–100) |
input | object | Исходные входные параметры задачи |
input.imageUrl | string | URL изображения сцены комнаты |
input.furnitureList | array | Список отправленных предметов мебели (макс. 6 элементов) |
input.furnitureList[].imageUrl | string | URL изображения предмета мебели |
input.prompt | string | Пользовательский текстовый промпт (если указан) |
input.modelType | 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 | Ошибка параметров запроса: например, отсутствует imageUrl или furnitureList либо furnitureList содержит более 6 элементов | Убедитесь, что imageUrl и furnitureList переданы и не пусты, а список содержит не более 6 элементов |
5002 | API_KEY_INVALID | Недействительный или отсутствующий ключ API | Убедитесь, что заголовок APIKEY присутствует и значение корректно |
9010 | SCAN_TEXT_ERROR | Текстовый запрос не прошёл проверку контента | Удалите из запроса чувствительный или запрещённый контент |
9038 | PROHIBITED_CONTENT | Сгенерированное выходное изображение содержит запрещенный контент | Отрегулируйте промпт/стиль/входные данные и повторите попытку |
9051 | COINS_NOT_ENOUGH | Недостаточно монет / кредитов | Пополните кредиты на вашем аккаунте и повторите попытку |
📄 Для полного списка общих кодов ошибок API см. Справочник кодов ошибок.