Ideal House
Zum Hauptinhalt springen

API-Stilkonfiguration Dokumentation#

Basis-URL: https://api.ideal.house
Version: v1
Aktualisiert: 2026-05-21


📖 Übersicht#

Der API-Stilkonfiguration-Endpunkt gibt Stiloption-Gruppen zurück, die von Generierungs-APIs verwendet werden. Diese Optionen bieten gültige IDs für Anfragefelder wie styleId, roomId, indoorStyleId, sceneId und ähnliche Stilparameter.

Unterstützte Funktionsseiten umfassen:

FunktiontoolName
Planvisualisierungai_plan_visualizer
Möbel ändernchange_furniture
Außengestaltungexterior_renovator
Raumdekorationhome_decor_ideas
Innenraumrenovierunginteroir_remodel
Gartengestaltunglandscaping
Virtuelle Raumausstattungvirtual_staging

Die aktuellen Ressourcendateien umfassen virtual-staging.json, sodass virtual_staging der gültige Werkzeugname für die virtuelle Raumausstattung ist. Die falsch geschriebene Version virual_staging wird von der aktuellen Ressourcendatei nicht unterstützt und gibt leere Inhalte zurück. Jeder nicht unterstützte toolName gibt leere Inhalte zurück.


🔐 Authentifizierung#

KopfzeileWert
APIKEYyour_api_key_here

📌 API-Endpunkt#

Stilkonfiguration abrufen#

Endpunkt

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

Anforderungsheader

KopfzeileErforderlichBeschreibung
APIKEY✅ JaIhr API Authentifizierungsschlüssel

Pfadparameter

ParameterTypErforderlichBeschreibung
toolNamestring✅ JaFunktionsname, zum Beispiel change_furniture oder ai_plan_visualizer

📥 Anfragbeispiel#

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

📤 Antwortstruktur#

Der Antwortkörper ist nach Stilbereich gruppiert. Jeder Bereich wird über backendParamKey einem Anfrageparameter zugeordnet.

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"
        }
      ]
    }
  }
}
FeldTypBeschreibung
backendParamKeystringAnfragekörperfeld, das die ausgewählte Option id empfangen soll
optionsarrayVerfügbare Stileoptionen
options[].nameobjectMehrsprachiger Stilname
options[].idstringStil-ID, die in die API-Anfrage übernommen werden soll
options[].urlstringVorschaubild, das den Stil zeigt

Einige Anfragefelder unterstützen mehrere Options-IDs. Für diese Felder werden die ausgewählten id-Werte durch Kommas getrennt, z. B. id1,id2.


🧭 Zuordnung der Werkzeugnamen#

Planvisualisierung#

Klartext
GET /api/v1/style/ai_plan_visualizer/getStyles
StilgruppeAnfragefeld
planTypeplanStyleId
stylestyleId
viewviewId

Möbel ändern#

Klartext
GET /api/v1/style/change_furniture/getStyles
StilgruppeAnfragefeld
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (unterstützt mehrere durch Kommas getrennte IDs)

Außengestaltung#

Klartext
GET /api/v1/style/exterior_renovator/getStyles
StilgruppeAnfragefeld
buildingStylebuildingStyleId
environmentenvironmentId (unterstützt mehrere durch Kommas getrennte IDs)

Raumdekoration#

Klartext
GET /api/v1/style/home_decor_ideas/getStyles
StilgruppeAnfragefeld
spaceTypespaceStyleId
decorStylehomeDecorStyleId

Innenraumrenovierung#

Klartext
GET /api/v1/style/interoir_remodel/getStyles
StilgruppeAnfragefeld
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (unterstützt mehrere durch Kommas getrennte IDs)

Gartengestaltung#

Klartext
GET /api/v1/style/landscaping/getStyles
StilgruppeAnfragefeld
gardenStylesceneId
elementssceneElementId (unterstützt mehrere durch Kommas getrennte IDs)

Virtuelle Raumausstattung#

Klartext
GET /api/v1/style/virtual_staging/getStyles
StilgruppeAnfragefeld
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId (unterstützt mehrere durch Kommas getrennte IDs)

❌ Fehlerantworten#

CodeNameBeschreibung
5002API_KEY_INVALIDUngültiger oder fehlender API Schlüssel

Bei nicht unterstützten toolName-Werten gibt der Endpunkt leere Inhalte in data zurück.