Getting Started with API Endpoints

Getting Started with API Endpoints: Your Guide to Endpoints

Welcome to your comprehensive guide to using our API endpoints. This resource is designed to help you understand how to leverage our platform's capabilities to optimize your workflows and services effectively.

What is an Endpoint?

An API endpoint is a designated URL that acts as a communication link between your application and our system. Endpoints allow you to send and receive data to perform specific tasks, such as submitting orders, retrieving catalog details, etc. They serve as building blocks for seamless integration, enabling efficient automation and data exchange.

Endpoints Overview

Below is a summary of the endpoints we provide, highlighting their purpose and usage:

1. Image Upload Upload images to attach to orders or include as part of a submission.

   • Method: POST

   • URL: https://api.aihomedesign.com/v1/order/image

2. Submit Order Submit new orders for processing across supported services.

   • Method: POST

   • URL: https://api.aihomedesign.com/v1/order

3. Get Spaces Access the list of spaces for each service in the catalog.

   • Method: GET

   • URL: https://api.aihomedesign.com/v1/catalog/spaces

4. Get Widgets (not required for AI Item Removal): Access the list of widgets available for various services.

   • Method: GET

   • URL: https://api.aihomedesign.com/v1/catalog/widgets

5. Get Widget Items Access the list of items offered within a widget.

   • Method: GET

   • URL: https://api.aihomedesign.com/v1/catalog/widgets/{widget_id}/items

6. Get Order Details Access comprehensive information about a specific order.

   • Method: GET

   • URL: https://api.aihomedesign.com/v1/order/{order_id}