Dokumentacja konfiguracji stylu API#
Podstawowy URL: https://api.ideal.house
Wersja: v1
Zaktualizowano: 2026-05-21
📖 Przegląd#
Punkt końcowy konfiguracji stylu API zwraca grupy opcji stylu używane przez interfejsy generowania. Te opcje zapewniają poprawne identyfikatory dla pól żądania, takich jak styleId, roomId, indoorStyleId, sceneId oraz podobne parametry stylu.
Obsługiwane strony funkcji obejmują:
Bieżące pliki zasobów obejmują virtual-staging.json, dlatego virtual_staging jest prawidłową nazwą narzędzia do wirtualnego umeblowania. Błędna nazwa virual_staging nie ma odpowiadającego pliku zasobów i zwraca pustą zawartość. Każda nieobsługiwana wartość toolName zwraca pustą zawartość.
🔐 Uwierzytelnianie#
📌 Punkt końcowy API#
Pobierz konfigurację stylu#
Punkt końcowy
GET /api/v1/style/{toolName}/getStyles
Nagłówki żądania
Parametry ścieżki
📥 Przykład żądania#
curl -X GET "https://api.ideal.house/api/v1/style/change_furniture/getStyles" \
-H "APIKEY: your_api_key_here"
📤 Struktura odpowiedzi#
Ciało odpowiedzi jest grupowane według kategorii stylu. Każda kategoria jest mapowana do parametru żądania za pomocą pola backendParamKey.
{
"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"
}
]
}
}
}
Niektóre pola żądania obsługują wiele identyfikatorów opcji. Dla tych pól połącz wybrane wartości id przecinkiem, na przykład id1,id2.
🧭 Mapowanie nazw narzędzi#
Wizualizator planu#
GET /api/v1/style/ai_plan_visualizer/getStyles
Zmiana mebli#
GET /api/v1/style/change_furniture/getStyles
Renowacja elewacji#
GET /api/v1/style/exterior_renovator/getStyles
Dekoracja domu#
GET /api/v1/style/home_decor_ideas/getStyles
Remont wnętrza#
GET /api/v1/style/interoir_remodel/getStyles
Zagospodarowanie terenu#
GET /api/v1/style/landscaping/getStyles
Wirtualne wystawianie#
GET /api/v1/style/virtual_staging/getStyles
❌ Odpowiedzi błędów#
Dla nieobsługiwanych wartości toolName, punkt końcowy zwraca pustą zawartość w polu data.