API 스타일 설정 문서#

기본 URL: https://api.ideal.house
버전: v1
갱신일: 2026-05-21

📖 개요#

API 스타일 설정 엔드포인트는 생성 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를 지원합니다. 이 필드에는 id1,id2처럼 선택한 id 값을 쉼표로 구분하여 전달하세요.

🧭 도구 이름 매핑#

도면 시각화#

일반 텍스트

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에 빈 내용을 반환합니다.