API Style Config Documentation

Base URL: https://api.ideal.house
Version: v1
Updated: 2026-05-21

📖 Overview

The API Style Config endpoint returns style option groups used by generation APIs. These options provide valid IDs for request fields such as styleId, roomId, indoorStyleId, sceneId, and similar style parameters.

Supported feature pages include:

Feature	`toolName`
Plan Visualizer	`ai_plan_visualizer`
Change Furniture	`change_furniture`
Exterior Renovator	`exterior_renovator`
Home Decor	`home_decor_ideas`
Interior Remodel	`interoir_remodel`
Landscaping	`landscaping`
Virtual Staging	`virtual_staging`

Current resource files include virtual-staging.json, so virtual_staging is the working tool name for Virtual Staging. The misspelled virual_staging is not backed by the current resource file and returns empty content. Any unsupported toolName returns empty content.

🔐 Authentication

Header	Value
`APIKEY`	`your_api_key_here`

📌 API Endpoint

Get Style Config

Endpoint

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

Request Headers

Header	Required	Description
`APIKEY`	✅ Yes	Your API authentication key

Path Parameters

Parameter	Type	Required	Description
`toolName`	`string`	✅ Yes	Feature name, for example `change_furniture` or `ai_plan_visualizer`

📥 Request Example

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

📤 Response Structure

The response body is grouped by style category. Each category maps to a request parameter through backendParamKey.

{
  "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"
        }
      ]
    }
  }
}

Field	Type	Description
`backendParamKey`	`string`	Request body field that should receive the selected option `id`
`options`	`array`	Available style options
`options[].name`	`object`	Multilingual style name
`options[].id`	`string`	Style ID to pass into the API request
`options[].url`	`string`	Preview image showing the style

Some request fields support multiple option IDs. For those fields, join selected id values with a comma, for example id1,id2.

🧭 Tool Name Mapping

Plan Visualizer

GET /api/v1/style/ai_plan_visualizer/getStyles

Style Group	Request Field
`planType`	`planStyleId`
`style`	`styleId`
`view`	`viewId`

Change Furniture

GET /api/v1/style/change_furniture/getStyles

Style Group	Request Field
`roomType`	`indoorTypeId`
`style`	`indoorStyleId`
`elements`	`indoorElemId` (supports comma-separated multiple IDs)

Exterior Renovator

GET /api/v1/style/exterior_renovator/getStyles

Style Group	Request Field
`buildingStyle`	`buildingStyleId`
`environment`	`environmentId` (supports comma-separated multiple IDs)

Home Decor

GET /api/v1/style/home_decor_ideas/getStyles

Style Group	Request Field
`spaceType`	`spaceStyleId`
`decorStyle`	`homeDecorStyleId`

Interior Remodel

GET /api/v1/style/interoir_remodel/getStyles

Style Group	Request Field
`roomType`	`indoorTypeId`
`style`	`indoorStyleId`
`elements`	`indoorElemId` (supports comma-separated multiple IDs)

Landscaping

GET /api/v1/style/landscaping/getStyles

Style Group	Request Field
`gardenStyle`	`sceneId`
`elements`	`sceneElementId` (supports comma-separated multiple IDs)

Virtual Staging

GET /api/v1/style/virtual_staging/getStyles

Style Group	Request Field
`roomType`	`indoorTypeId`
`style`	`indoorStyleId`
`elements`	`indoorElemId` (supports comma-separated multiple IDs)

❌ Error Responses

Code	Name	Description
`5002`	`API_KEY_INVALID`	Invalid or missing API key

For unsupported toolName values, the endpoint returns empty content in data.