Checking an image/order has been enhanced

As our system enhances images concurrently you will need to check the

Once your image has been uploaded to our service, you can check the status of the image by calling;

Check the status of a single image

GET https://api.autoenhance.ai/v2/image/:image_id

Path Parameters

NameTypeDescription

image_id

string

image_id was provided when you made your post request to /image in step 2

{
  "image_id": uuid,
  "order_id": uuid,
  "image_name": string,
  "enhance_type": string,
  "image_type": string,
  "status": string,
  "sky_replacement": boolean,
  "vertical_correction": boolean,
  "room_type": string
}

If your image is being processed, the image status will be "processing". When an image has completed processing, the status will be "processed".

If you want to check a group of photos that all have the same order_id, you can call;

Check the status of a group of images (order)

GET https://api.autoenhance.ai/v2/order/:order_id

Path Parameters

NameTypeDescription

order_id

string

order_id is defined when the image was uploaded to POST /image

{
  "order_id": uuid,
  "is_processing": boolean,
  "images": [
    {
      "image_id": uuid,
      "order_id": uuid,
      "image_name": string,
      "enhance_type": string,
      "image_type": string,
      "status": string,
      "sky_replacement": boolean,
      "vertical_correction": boolean,
      "room_type": string
    }
  ]
}

You can check individual images status or check the status of the whole order. If the order is processing, is_processing will be true. If it is complete, is_processing will be false.

Last updated