Ideal House
Перейти к содержанию

Документация по конфигурации стилей API#

Базовый URL: https://api.ideal.house
Версия: v1
Обновлено: 2026-05-21


📖 Обзор#

Конечная точка API настройки стиля возвращает группы вариантов стиля, используемые API генерации. Эти варианты предоставляют допустимые идентификаторы для полей запроса, таких как styleId, roomId, indoorStyleId, sceneId и аналогичных параметров стиля.

Поддерживаемые страницы функций включают:

ФункцияtoolName
Визуализация планаai_plan_visualizer
Замена мебелиchange_furniture
Обновление экстерьераexterior_renovator
Декорирование домаhome_decor_ideas
Обновление интерьераinteroir_remodel
Ландшафтный дизайнlandscaping
Виртуальная меблировкаvirtual_staging

Текущие файлы ресурсов включают virtual-staging.json, поэтому virtual_staging — это рабочее имя инструмента для виртуальной меблировки. Опечатка virual_staging не поддерживается текущим файлом ресурсов и возвращает пустое содержимое. Любое неподдерживаемое значение toolName возвращает пустое содержимое.


🔐 Аутентификация#

ЗаголовокЗначение
APIKEYyour_api_key_here

📌 Конечная точка API#

Получение конфигурации стилей#

Конечная точка

Обычный текст
GET /api/v1/style/{toolName}/getStyles

Заголовки запроса

ЗаголовокОбязательныйОписание
APIKEY✅ ДаВаш ключ аутентификации API

Параметры пути

ПараметрТипОбязательныйОписание
toolNamestring✅ ДаНазвание функции, например change_furniture или ai_plan_visualizer

📥 Пример запроса#

bash
curl -X GET "https://api.ideal.house/api/v1/style/change_furniture/getStyles" \
  -H "APIKEY: your_api_key_here"

📤 Структура ответа#

Тело ответа сгруппировано по категориям стилей. Каждая категория сопоставляется с параметром запроса через backendParamKey.

json
{
  "code": 0,
  "message": "success",
  "data": {
    "roomType": {
      "backendParamKey": "indoorTypeId",
      "options": [
        {
          "name": {
            "en": "Living Room",
            "zh-CN": "客厅"
          },
          "id": "Interior Design_Interior Scene_Living Room",
          "url": "https://example.com/style-preview.webp"
        }
      ]
    }
  }
}
ПолеТипОписание
backendParamKeystringПоле тела запроса, которое должно принимать id выбранной опции
optionsarrayДоступные опции стиля
options[].nameobjectМногоязычное название стиля
options[].idstringИдентификатор стиля для передачи в запрос API
options[].urlstringИзображение-превью, демонстрирующее стиль

Некоторые поля запроса поддерживают несколько идентификаторов опций. Для таких полей объединяйте выбранные значения id запятой, например id1,id2.


🧭 Соответствие имен инструментов#

Визуализация плана#

Обычный текст
GET /api/v1/style/ai_plan_visualizer/getStyles
Группа стилейПоле запроса
planTypeplanStyleId
stylestyleId
viewviewId

Замена мебели#

Обычный текст
GET /api/v1/style/change_furniture/getStyles
Группа стилейПоле запроса
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (поддерживает несколько идентификаторов через запятую)

Обновление экстерьера#

Обычный текст
GET /api/v1/style/exterior_renovator/getStyles
Группа стилейПоле запроса
buildingStylebuildingStyleId
environmentenvironmentId (поддерживает несколько идентификаторов через запятую)

Декорирование дома#

Обычный текст
GET /api/v1/style/home_decor_ideas/getStyles
Группа стилейПоле запроса
spaceTypespaceStyleId
decorStylehomeDecorStyleId

Обновление интерьера#

Обычный текст
GET /api/v1/style/interoir_remodel/getStyles
Группа стилейПоле запроса
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (поддерживает несколько идентификаторов через запятую)

Ландшафтный дизайн#

Обычный текст
GET /api/v1/style/landscaping/getStyles
Группа стилейПоле запроса
gardenStylesceneId
elementssceneElementId (поддерживает несколько идентификаторов через запятую)

Виртуальная меблировка#

Обычный текст
GET /api/v1/style/virtual_staging/getStyles
Группа стилейПоле запроса
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (поддерживает несколько идентификаторов через запятую)

❌ Ответы об ошибках#

КодНазваниеОписание
5002API_KEY_INVALIDНедействительный или отсутствующий ключ API

Для неподдерживаемых значений toolName точка входа возвращает пустое содержимое в data.