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 Spaces

Get Available Spaces for Each Service

Explanation

Before submitting any order, use this API to check the available spaces. The space_name field may be mandatory for specific services; if required, set space_name based on the uploaded image.


GET https://api.aihomedesign.com/v1/catalog/spaces


Query Parameters:

  • active (boolean): Set to true to retrieve only active widgets.

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

Response

{
    "data": [
        {
            "id": string,
            "name": string,
            "title": string,
            "description": string,
            "prompt": string,
            "icon_src": string,
            "is_active": boolean,
            "is_premium": boolean
        }
    ]
}
{
    "error": string,
    "key": string
}
PreviousAI Item Removal MaskNextGet Widgets and Items

Last updated 5 months ago