API スタイル設定ドキュメント#

ベース URL: https://api.ideal.house
バージョン: v1
更新日: 2026-05-21

📖 概要#

API スタイル設定エンドポイントは、生成機能で使用するスタイルの選択肢グループを返します。これらの選択肢は、styleId、roomId、indoorStyleId、sceneId などのスタイルパラメーターのリクエストフィールドに指定できる有効な ID を提供します。

対応する機能ページは次のとおりです。

機能	`toolName`
図面可視化	`ai_plan_visualizer`
家具変更	`change_furniture`
外観リフォーム	`exterior_renovator`
室内装飾	`home_decor_ideas`
室内リフォーム	`interoir_remodel`
造園	`landscaping`
バーチャルステージング	`virtual_staging`

現在のリソースファイルには virtual-staging.json が含まれるため、バーチャルステージングの有効なツール名は 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 のようにカンマで連結します。

🧭 ツール名の対応表#

図面可視化#

プレーンテキスト

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 キーが無効または未指定

未対応の toolName 値に対しては、エンドポイントは data に空の内容を返します。