API Style Config 文档#

基础 URL： https://api.ideal.house
版本： v1
更新日期： 2026-05-21

📖 概述#

API Style Config 端点返回生成 API 所使用的风格选项组。这些选项为 styleId、roomId、indoorStyleId、sceneId 等请求字段提供合法的 ID。

支持的功能页面包括：

功能	`toolName`
Plan Visualizer（平面图可视化）	`ai_plan_visualizer`
更换家具	`change_furniture`
外立面改造	`exterior_renovator`
家居装饰	`home_decor_ideas`
室内改造	`interoir_remodel`
景观绿化	`landscaping`
虚拟布置	`virtual_staging`

当前资源文件包含 virtual-staging.json，因此 virtual_staging 是 Virtual Staging 的工作工具名。拼写错误的 virual_staging 没有对应的资源文件支持，将返回空内容。任何不受支持的 toolName 值均返回空内容。

🔐 身份验证#

请求头	值
`APIKEY`	`your_api_key_here`

📌 API 端点#

获取样式配置#

端点

纯文本

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

请求头

请求头	必填	说明
`APIKEY`	✅ 是	你的 API 身份验证密钥

路径参数

参数	类型	必填	说明
`toolName`	`string`	✅ 是	功能名称，例如 `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"
        }
      ]
    }
  }
}

字段	类型	说明
`backendParamKey`	`string`	接收所选选项 `id` 的请求体字段
`options`	`array`	可用的样式选项
`options[].name`	`object`	多语言样式名称
`options[].id`	`string`	传入 API 请求的样式 ID
`options[].url`	`string`	展示样式的预览图像

部分请求字段支持多个选项 ID。对于这些字段，使用逗号连接选中的 id 值，例如 id1,id2。

🧭 工具名称映射#

Plan Visualizer（平面图可视化）#

纯文本

GET /api/v1/style/ai_plan_visualizer/getStyles

样式组	请求字段
`planType`	`planStyleId`
`style`	`styleId`
`view`	`viewId`

更换家具#

纯文本

GET /api/v1/style/change_furniture/getStyles

样式组	请求字段
`roomType`	`indoorTypeId`
`style`	`indoorStyleId`
`elements`	`indoorElemId`（支持逗号分隔的多个 ID）

外立面改造#

纯文本

GET /api/v1/style/exterior_renovator/getStyles

样式组	请求字段
`buildingStyle`	`buildingStyleId`
`environment`	`environmentId`（支持逗号分隔的多个 ID）

家居装饰#

纯文本

GET /api/v1/style/home_decor_ideas/getStyles

样式组	请求字段
`spaceType`	`spaceStyleId`
`decorStyle`	`homeDecorStyleId`

室内改造#

纯文本

GET /api/v1/style/interoir_remodel/getStyles

样式组	请求字段
`roomType`	`indoorTypeId`
`style`	`indoorStyleId`
`elements`	`indoorElemId`（支持逗号分隔的多个 ID）

景观绿化#

纯文本

GET /api/v1/style/landscaping/getStyles

样式组	请求字段
`gardenStyle`	`sceneId`
`elements`	`sceneElementId`（支持逗号分隔的多个 ID）

虚拟布置#

纯文本

GET /api/v1/style/virtual_staging/getStyles

样式组	请求字段
`roomType`	`indoorTypeId`
`style`	`indoorStyleId`
`elements`	`indoorElemId`（支持逗号分隔的多个 ID）

❌ 错误响应#

代码	名称	说明
`5002`	`API_KEY_INVALID`	API Key 无效或缺失

对于不受支持的 toolName 值，端点将在 data 中返回空内容。