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
  1. API Endpoints

Generated Image Webhook

Webhook in Case of Image Generation

Explanation

To receive the generated image URL (after_src), configure a webhook endpoint in the API-access section of your dashboard. Then, submit an order. Upon completion, you'll receive an order_id and an estimated time of arrival (ETA) in the response. Once ready, we'll send a request to your designated endpoint, including the after_src parameter, as shown below:

Request Body

{
    "order_id":string,
    "image":{
        "id":string,
        "before_src":string,
        "after_src":string,
        "regenerated":boolean,
        "style": string,
        "color":string,
        "space":string,
        "sky_style":string,
        "shadow_removal":boolean,
        "material":string,
        "created_at":date-time in string format
    },
    "service_name":string,
    "user_id":string 
}

PreviousGet Order DetailsNextUpscale Download Webhook

Last updated 6 months ago