Ideal House
Naar inhoud gaan

Documentatie voor API-stijlconfiguratie#

Basis-URL: https://api.ideal.house
Versie: v1
Bijgewerkt: 2026-05-21


📖 Overzicht#

Het endpoint voor API-stijlconfiguratie retourneert groepen stijlopties die generatie-API's gebruiken. Deze opties leveren geldige ID's voor verzoekvelden zoals styleId, roomId, indoorStyleId, sceneId en vergelijkbare stijlparameters.

Ondersteunde functiepagina's zijn:

FunctietoolName
Planvisualisatieai_plan_visualizer
Meubelvervangingchange_furniture
Buitenrenovatieexterior_renovator
Kamerdecoratiehome_decor_ideas
Interieurrenovatieinteroir_remodel
Tuinontwerplandscaping
Virtuele inrichtingvirtual_staging

De huidige bronbestanden bevatten virtual-staging.json, dus virtual_staging is de werkende toolnaam voor virtuele inrichting. De verkeerd gespelde virual_staging wordt niet door het huidige bronbestand ondersteund en retourneert lege inhoud. Elke niet-ondersteunde toolName retourneert lege inhoud.


🔐 Authenticatie#

VerzoekheaderWaarde
APIKEYyour_api_key_here

📌 API-eindpunt#

Stijlconfiguratie ophalen#

Eindpunt

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

Verzoekheaders

VerzoekheaderVerplichtBeschrijving
APIKEY✅ JaJe API-authenticatiesleutel

Padparameters

QueryparameterTypeVerplichtBeschrijving
toolNamestring✅ JaFunctienaam, bijvoorbeeld change_furniture of ai_plan_visualizer

📥 Verzoekvoorbeeld#

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

📤 Antwoordstructuur#

De antwoordinhoud is gegroepeerd per stijlcategorie. Elke categorie wordt via backendParamKey aan een verzoekparameter gekoppeld.

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"
        }
      ]
    }
  }
}
VeldTypeBeschrijving
backendParamKeystringVeld in de verzoekinhoud dat de id van de geselecteerde optie moet ontvangen
optionsarrayBeschikbare stijlopties
options[].nameobjectMeertalige stijlnaam
options[].idstringStijl-ID om in het API-verzoek door te geven
options[].urlstringVoorbeeldafbeelding van de stijl

Sommige verzoekvelden ondersteunen meerdere optie-ID's. Verbind voor die velden de geselecteerde id-waarden met een komma, bijvoorbeeld id1,id2.


🧭 Koppeling van toolnamen#

Planvisualisatie#

Platte tekst
GET /api/v1/style/ai_plan_visualizer/getStyles
StijlgroepVerzoekveld
planTypeplanStyleId
stylestyleId
viewviewId

Meubelvervanging#

Platte tekst
GET /api/v1/style/change_furniture/getStyles
StijlgroepVerzoekveld
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId: ondersteunt meerdere ID's gescheiden door komma's

Buitenrenovatie#

Platte tekst
GET /api/v1/style/exterior_renovator/getStyles
StijlgroepVerzoekveld
buildingStylebuildingStyleId
environmentenvironmentId: ondersteunt meerdere ID's gescheiden door komma's

Kamerdecoratie#

Platte tekst
GET /api/v1/style/home_decor_ideas/getStyles
StijlgroepVerzoekveld
spaceTypespaceStyleId
decorStylehomeDecorStyleId

Interieurrenovatie#

Platte tekst
GET /api/v1/style/interoir_remodel/getStyles
StijlgroepVerzoekveld
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId: ondersteunt meerdere ID's gescheiden door komma's

Tuinontwerp#

Platte tekst
GET /api/v1/style/landscaping/getStyles
StijlgroepVerzoekveld
gardenStylesceneId
elementssceneElementId: ondersteunt meerdere ID's gescheiden door komma's

Virtuele inrichting#

Platte tekst
GET /api/v1/style/virtual_staging/getStyles
StijlgroepVerzoekveld
roomTypeindoorTypeId
styleindoorStyleId
elementsindoorElemId: ondersteunt meerdere ID's gescheiden door komma's

❌ Foutantwoorden#

CodeNaamBeschrijving
5002API_KEY_INVALIDOngeldige of ontbrekende API-sleutel

Voor niet-ondersteunde toolName-waarden retourneert het endpoint lege inhoud in data.