API शैली कॉन्फ़िग दस्तावेज़ीकरण#

मूल URL: https://api.ideal.house
संस्करण: v1
अपडेट किया गया: 2026-05-21

📖 अवलोकन#

API शैली कॉन्फ़िग एंडपॉइंट जनरेशन API द्वारा उपयोग की जाने वाली शैली विकल्प समूह लौटाना है। ये विकल्प styleId, roomId, indoorStyleId, sceneId और समान शैली पैरामीटर जैसे अनुरोध फ़ील्ड के लिए मान्य ID प्रदान करते हैं।

समर्थित फ़ीचर पेज शामिल हैं:

वर्तमान संसाधन फ़ाइलों में virtual-staging.json शामिल है, इसलिए virtual_staging वर्चुअल साज-सज्जा के लिए कार्यशील टूल नाम है। गलत वर्तनी वाले virual_staging का वर्तमान संसाधन फ़ाइल द्वारा समर्थन नहीं है और यह खाली सामग्री लौटता है। कोई भी असमर्थित toolName खाली सामग्री लौटता है।

🔐 प्रमाणीकरण#

📌 API एंडपॉइंट#

Style Config प्राप्त करें#

एंडपॉइंट

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

अनुरोध हेडर

Path पैरामीटर

📥 अनुरोध उदाहरण#

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

📤 प्रतिक्रिया संरचना#

प्रतिक्रिया शरीर शैली श्रेणी के अनुसार समूहीकृत है। प्रत्येक श्रेणी 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"
        }
      ]
    }
  }
}

कुछ अनुरोध फ़ील्ड कई विकल्प IDs का समर्थन करती हैं। उन फ़ील्ड के लिए, चयनित id मानों को एक कॉमा से जोड़ें, उदाहरण के लिए id1,id2।

🧭 टूल नाम मैपिंग#

प्लान विज़ुअलाइज़र#

GET /api/v1/style/ai_plan_visualizer/getStyles

फ़र्नीचर बदलना#

GET /api/v1/style/change_furniture/getStyles

बाहरी नवीनीकरण#

GET /api/v1/style/exterior_renovator/getStyles

होम डेकोर#

GET /api/v1/style/home_decor_ideas/getStyles

इंटीरियर रिमॉडल#

GET /api/v1/style/interoir_remodel/getStyles

लैंडस्केपिंग#

GET /api/v1/style/landscaping/getStyles

वर्चुअल स्टेजिंग#

GET /api/v1/style/virtual_staging/getStyles

❌ त्रुटि प्रतिक्रियाएँ#

असमर्थित toolName मानों के लिए, endpoint data में खाली content लौटता है।