# API Documentation ## API Documentation - [Introduction](https://api.homedesigns.ai/homedesignsai-api-documentation/introduction.md): Integrate the World’s Leading Home Design AI Technology in Your Website, Web App, Mobile App, Desktop App, e-Commerce Store. - [API Reference](https://api.homedesigns.ai/homedesignsai-api-documentation/api-reference.md) - [Authentication](https://api.homedesigns.ai/homedesignsai-api-documentation/authentication.md) - [Magic redesign](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/magic-redesign.md) - [Video Generation](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/video-generation.md) - [Smart Room Composer](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/smart-room-composer.md) - [Perfect Redesign](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/perfect-redesign.md) - [Beautiful Redesign](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/beautiful-redesign.md) - [Creative Redesign](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/creative-redesign.md) - [Sketch to Render](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/sketch-to-render.md) - [Virtual staging](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/virtual-staging.md) - [Precision](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/precision.md) - [Fill Spaces](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/fill-spaces.md) - [Decor Staging](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/decor-staging.md) - [Furniture Removal](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/furniture-removal.md) - [Colors & Textures](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/colors-and-textures.md) - [Furniture Finder](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/furniture-finder.md) - [Full HD](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/full-hd.md) - [Text to design](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/text-to-design.md) - [Furniture Creator](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/furniture-creator.md) - [Design Advisor](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/design-advisor.md) - [Sky Colors](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/sky-colors.md) - [Design Transfer](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/design-transfer.md) - [Floor Editor](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/floor-editor.md) - [Paint Visualizer](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/paint-visualizer.md) - [Material Swap](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/material-swap.md) - [Room Composer](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/room-composer.md) - [Design Critique](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/design-critique.md) - [Create Mask Image](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/create-mask-image.md) - [Download Generated Images & Videos](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/download-generated-images-and-videos.md) - [Smart Home AI](https://api.homedesigns.ai/homedesignsai-api-documentation/core-apis/smart-home-ai.md) - [Interiors](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/interiors.md) - [Design Styles for Interiors](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/interiors/design-styles-for-interiors.md): Discover a variety of design styles for your interior projects in HomeDesignsAI. Create elegant and personalized living spaces. - [Room Types](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/interiors/room-types.md): Select this to get design styles and room types related to interior spaces like living rooms, bedrooms, etc. - [Colors in Interior Design](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/interiors/colors-in-interior-design.md): Explore color options for interior designs in HomeDesignsAI. Discover how to create stylish spaces with vibrant and harmonious hues. - [Explore Material Options for Interior Designs](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/interiors/explore-material-options-for-interior-designs.md): Learn how to enhance your interior designs with a range of materials in HomeDesignsAI. Create stylish and personalized living spaces. - [Exteriors](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/exteriors.md) - [Design Styles for Exteriors](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/exteriors/design-styles-for-exteriors.md): Discover a variety of design styles for your exterior projects in HomeDesignsAI. Create beautiful and distinctive outdoor spaces. - [House angles](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/exteriors/house-angles.md) - [Exterior Colors](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/exteriors/exterior-colors.md): Explore the color options for exterior designs in HomeDesignsAI API. Discover how to enhance your home’s curb appeal with vibrant hues. - [Material Options for Exterior Designs](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/exteriors/material-options-for-exterior-designs.md): Learn how to enhance your exterior designs with a variety of materials in HomeDesignsAI. Create stunning and personalized outdoor spaces. - [Gardens](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/gardens.md) - [Design Styles for Gardens](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/gardens/design-styles-for-gardens.md): Discover a range of design styles for your garden projects in HomeDesignsAI. Create beautiful and unique outdoor environments. - [Garden Types](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/gardens/garden-types.md) - [Explore Color Options for Garden Designs](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/gardens/explore-color-options-for-garden-designs.md): Discover how to enhance garden designs with vibrant colors using HomeDesignsAI's API. Create stunning outdoor visualizations. - [Material Options for Garden Designs](https://api.homedesigns.ai/homedesignsai-api-documentation/design-scope/gardens/material-options-for-garden-designs.md): Discover how to elevate your garden designs with various materials in HomeDesignsAI. Create unique and inviting outdoor spaces. - [User Details](https://api.homedesigns.ai/homedesignsai-api-documentation/data/user-details.md): This API retrieves user information based on the provided API access token. It returns user details along with active subscription data. - [Design Scope](https://api.homedesigns.ai/homedesignsai-api-documentation/data/design-scope.md): This API retrieves design scope information, providing details on design types, design styles, room types, colors, and other relevant data. - [What is Masked Image?](https://api.homedesigns.ai/homedesignsai-api-documentation/others/what-is-masked-image.md) - [HomeDesigns AI - API Privacy Policy](https://api.homedesigns.ai/homedesignsai-api-documentation/others/homedesigns-ai-api-privacy-policy.md) - [HomeDesigns AI - API Terms of Service](https://api.homedesigns.ai/homedesignsai-api-documentation/others/homedesigns-ai-api-terms-of-service.md) - [API Token Security & Access Control](https://api.homedesigns.ai/homedesignsai-api-documentation/others/api-token-security-and-access-control.md): This feature allows you to control how your API token can be used. It helps prevent unauthorized access and ensures that only trusted sources can access your API. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://api.homedesigns.ai/homedesignsai-api-documentation/introduction.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.