Ideal House
Saltar al contenido

Documentación de la configuración de estilo de la API#

URL base: https://api.ideal.house
Versión: v1
Actualizado: 2026-05-21


📖 Descripción general#

El endpoint de configuración de estilo de la API devuelve grupos de opciones de estilo utilizados por las APIs de generación. Estas opciones proporcionan identificadores válidos para campos de solicitud como styleId, roomId, indoorStyleId, sceneId y parámetros de estilo similares.

Las páginas de funciones compatibles incluyen:

FuncióntoolName
Visualización de planosai_plan_visualizer
Cambio de muebleschange_furniture
Renovación exteriorexterior_renovator
Decoración del hogarhome_decor_ideas
Remodelación interiorinteroir_remodel
Paisajismolandscaping
Ambientación virtualvirtual_staging

Los archivos de recursos actuales incluyen virtual-staging.json, por lo que virtual_staging es el nombre de la herramienta de trabajo para Ambientación virtual. virual_staging, que tiene un error tipográfico, no está respaldado por el archivo de recursos actual y devuelve contenido vacío. Cualquier toolName no compatible devuelve contenido vacío.


🔐 Autenticación#

EncabezadoValor
APIKEYyour_api_key_here

📌 Endpoint de la API#

Obtener configuración de estilo#

Endpoint

Texto plano
GET /api/v1/style/{toolName}/getStyles

Encabezados de la solicitud

EncabezadoObligatorioDescripción
APIKEY✅ SíTu clave de autenticación API

Parámetros de ruta

ParámetroTipoObligatorioDescripción
toolNamestring✅ SíNombre de la función, por ejemplo change_furniture o ai_plan_visualizer

📥 Ejemplo de solicitud#

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

📤 Estructura de respuesta#

El cuerpo de la respuesta se agrupa por categoría de estilo. Cada categoría se asigna a un parámetro de solicitud a través de 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"
        }
      ]
    }
  }
}
CampoTipoDescripción
backendParamKeystringCampo del cuerpo de la solicitud que debe recibir el id de la opción seleccionada
optionsarrayOpciones de estilo disponibles
options[].nameobjectNombre del estilo multilingüe
options[].idstringIdentificador de estilo para pasar a la solicitud de la API
options[].urlstringImagen de vista previa que muestra el estilo

Algunos campos de solicitud admiten varios identificadores de opción. Para esos campos, une los valores de id seleccionados con comas, por ejemplo id1,id2.


🧭 Asignación de nombres de herramientas#

Visualización de planos#

Texto plano
GET /api/v1/style/ai_plan_visualizer/getStyles
Grupo de estiloCampo de solicitud
planTypeplanStyleId
stylestyleId
viewviewId

Cambio de muebles#

Texto plano
GET /api/v1/style/change_furniture/getStyles
Grupo de estiloCampo de solicitud
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (admite varios identificadores separados por comas)

Renovación exterior#

Texto plano
GET /api/v1/style/exterior_renovator/getStyles
Grupo de estiloCampo de solicitud
buildingStylebuildingStyleId
environmentenvironmentId (admite varios identificadores separados por comas)

Decoración del hogar#

Texto plano
GET /api/v1/style/home_decor_ideas/getStyles
Grupo de estiloCampo de solicitud
spaceTypespaceStyleId
decorStylehomeDecorStyleId

Remodelación interior#

Texto plano
GET /api/v1/style/interoir_remodel/getStyles
Grupo de estiloCampo de solicitud
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (admite varios identificadores separados por comas)

Paisajismo#

Texto plano
GET /api/v1/style/landscaping/getStyles
Grupo de estiloCampo de solicitud
gardenStylesceneId
elementssceneElementId (admite varios identificadores separados por comas)

Ambientación virtual#

Texto plano
GET /api/v1/style/virtual_staging/getStyles
Grupo de estiloCampo de solicitud
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (admite varios identificadores separados por comas)

❌ Respuestas de error#

CódigoNombreDescripción
5002API_KEY_INVALIDClave API inválida o ausente

Para valores de toolName no compatibles, el endpoint devuelve contenido vacío en data.