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
  • 1. Get Your API Key & Set Up Your Webhook
  • 2. Authenticate Your Requests
  • 3. Upload Your Image
  • 4. Submit an Order
  • 5. Fetch Order Details
  1. introduction

Step-by-Step Guide

Step-by-Step Workflow Overview

PreviousHow to Use the API Key?NextGetting Started with API Endpoints

Last updated 3 months ago

This roadmap will guide you through every step of the process, ensuring that you know exactly what to do, how to do it, and why each step matters. Each section includes step-by-step instructions, common issues to avoid, and helpful tips to make your experience seamless.

1. Get Your & Set Up Your Webhook

Goal: Gain access to the system by obtaining your API key and configuring your webhook for real-time updates.

Step-by-Step Instructions

  1. Log in to your account.

  2. Go to the Section.

  3. Generate or Copy your API key.

  4. Set Your Webhook URL where you will receive updates and callbacks.

Important Notes

  • Security Tip: Treat your API key like a password. Don’t expose it publicly or share it with others.

  • Webhook URL: Make sure the URL is live, accessible, and ready to receive incoming requests.

Common Issues

  • Invalid API Key: Double-check that you’ve copied the key correctly.

  • Webhook Not Triggering: Ensure your server can receive POST requests and is not blocking unknown IPs.


2. Your Requests

Goal: Use your API key to verify and authorize every request you send to the system.

Add Your API Key to the header of every request as:

x-api-key : {Your_API_Key} 

Important Notes

  • API Key Regeneration: If your key is compromised, regenerate it immediately.

  • Common Error: “401 Unauthorized” — This means your API key might be missing or incorrect.


3. Upload Your Image

Goal: Upload images to the server's storage system in preparation for order submission.

Step-by-Step Instructions

  1. Prepare the Image File JPG,PNG,etc.

  2. Send a POST Request to the API endpoint with the image file as form-data.

  3. Receive the Response: The server will return a unique image identifier image_id.

Important Notes

  • File Size: Ensure your image is within the file size limits.

  • Supported Formats: Check which image formats are allowed JPG,PNG, etc.


4. Submit an Order

Goal: Submit an order and specify the service, spaces, widgets, and other parameters required to fulfill the order.

Step-by-Step Instructions

  1. Prepare Order Data:

    • Select the service you want to use.

    • Identify the spaces, widgets and items for the service.

    • Include the image_id from the previous step.

Important Notes

  • Webhook URL: Ensure your webhook is active, as the order status will be sent there.

  • Common Issues:

    • Missing Image ID: Ensure you provide the correct image identifier image_id.

    • Missing Service Data: Make sure to retrieve and understand the correct spaces, widgets, and items before submitting.


5. Fetch Order Details

Goal: Retrieve detailed information on a submitted order to check its progress or result.

Step-by-Step Instructions

  1. Review the Response: The response will include the current status, progress, and final result.

Important Notes

  • Check Status: Possible statuses may include in-progress or idle.

  • Order Tracking: If an order is taking longer than expected, track it using this endpoint.

  • Polling vs Webhook: Rely on the webhook for real-time updates, but you can also use this endpoint to manually check progress.

Access the Section of the API.

Retrieve Service Details: Get the list of available , of each service via API endpoints.

Submit the Order: Send a POST request to the endpoint.

Wait for the Webhook Callback: Once the order is processed, a will send the result back to your specified URL.

Submit a GET Request: Use the endpoint.

API Key
API access
Authenticate
Upload Image
spaces
widgets and items
Submit Order
webhook
Get Order Details