Upscale Download Webhook

Download Upscaled Images

Explanation

If you've already generated an image and want to obtain a higher-resolution version, you can request an upscaled image through this endpoint. After your request is processed, the upscaled image will be sent to your specified webhook URL. The upscaled image link will be included in the response under the field "upscaled_image_src".

The process consists of two steps:

1. Initiate the request to upscale the image.

2. Retrieve the image via the webhook notification.

Initiate the Request

---

POSThttps://api.aihomedesign.com/v1/order/image/{generated_image_id}/download/upscale

Where can I get the generated_image_id?

The generated images for an order can be accessed via the Get Order Details endpoint.

Request Body

The request body is not required for this endpoint and should be left empty.

Headers

Key	Value
x-api-key*	{your_api_key_here}

Response

200: OK

{ 
    status : "processing" 
}

---

Get Image via Webhook

After submitting the request, our system will process the image and send you a webhook notification to the URL you’ve specified in your dashboard. This notification will let you know when the upscaled image is ready and provide a link to download it, also you can identify the webhook request by the field named generated_image_id,which is the id of the image you've requested upscale for.

Request Body

{
   "generated_image_id": "SAMPLE-UUID",
   "upscaled_image_src" : "SAMPLE-DOWNLOAD-LINK",
   "user_id":"SAMPLE-UUID"
}