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
  • Request Body
  • Headers
  • Response
  1. API Endpoints

Image Upload

Uploading Image(s) to Submit an Order

Explanation

This API endpoint allows users to upload images to the server. It is designed to handle image files and store them in the server's storage system.

The API supports a wide range of image formats, including JPG, JPEG, PNG, and WEBP, as well as RAW file formats such as


POST https://api.aihomedesign.com/v1/order/image


Request Body

Ensure that your request body is in the form-data format.

Name
Type
Description

image*

File

Your image file Max size:50 MB

service_name*

Text

Possible options for service_name: service-creative-designer,

service-ai-virtual-staging,

service-item-removal,

service-day-to-dusk,

service-image-enhancement

Headers

Key
Value

x-api-key *

{your_api_key_here}

Response

{
    "order_id": string
}

If the image uploads successfully, the response will include an order_id.

Make sure you keep the order_id. You’ll need it to submit the order.

{
    "error": "http: no such file"
}

If no image is provided, the response will return an error.

PreviousGetting Started with API EndpointsNextSubmit Order

Last updated 5 months ago