AI HomeDesign API Docs
  • introduction
    • Getting Started
    • API Key
    • How to Use the API Key?
    • Step-by-Step Guide
  • API Endpoints
    • Getting Started with API Endpoints
    • Image Upload
    • Submit Order
      • AI Virtual Staging
      • AI Interior Design
      • AI Image Enhancement
      • AI Day to Dusk
      • AI Item Removal
      • AI Item Removal Mask
    • Get Spaces
    • Get Widgets and Items
    • Get Order Details
    • Generated Image Webhook
    • Upscale Download Webhook
    • Code Examples
      • Mask Canvas
    • Postman Workspace
  • Usage Limits and Policies
    • Rate Limit
  • Support and Contact
    • Help & Support
    • FAQs
Powered by GitBook
On this page
  • Explanation
  • Response
  1. API Endpoints

Get Widgets and Items

Get the Available Widgets and Items for Each Service

Explanation

This API must be called before submitting any order to check the availability of widgets and items. Widgets can be optional or mandatory depending on the service.


GET https://api.aihomedesign.com/v1/catalog/items/filter


Query Parameters:

  • space_name (string): Set your desired space name e.g. space-bedroom

  • service_name (string): Set your desired service name e.g. service-ai-creative-designer

Response

{
    "data": [
        {
            "id": string,
            "title": string,
            "description": string,
            "is_optional": boolean,
            "items": [
                {
                    "id": string,
                    "title": string,
                    "prompt": string,
                    "icon_src": string,
                    "is_premium": boolean
                }
            ],
            "priority": numeric,
            "type": string
        }
    ]
}
{
    "error": string,
    "key": string
}
PreviousGet SpacesNextGet Order Details

Last updated 3 months ago