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;

Retrieve Image

GEThttps://api.autoenhance.ai/v3/images/{id}

Path parameters

id*string

Response

200404

Successful response

Body

application/json

ai_versionnullable enum

1.133.13.23.34null

enhance_typenullable enum

The type of enhancement to apply to the image. PROPERTY or PROPERTY_USA is used with AI version < 4.0, for >= 4.0 use WARM, NEUTRAL, or AUTHENTIC.

propertyproperty_usawarmneutralauthenticnull

sky_replacementboolean

Whether the sky replacement feature was enabled for the image.

vertical_correctionboolean

Whether the vertical correction feature was enabled for the image.

lens_correctionboolean

Correct any lens distortion in the image.

contrast_boostnullable enum

The amount of contrast boost to apply to the image. Options include: NONE, LOW, MEDIUM, HIGH

NONELOWMEDIUMHIGHnull

brightness_boostnullable enum

The amount of brightness boost to apply to the image. Options include: NONE, LOW, MEDIUM, HIGH

NONELOWMEDIUMHIGHnull

saturation_levelnullable enum

The amount of saturation to apply to the image. Options include: NONE, LOW, MEDIUM, HIGH

NONELOWMEDIUMHIGHnull

sharpen_levelnullable enum

The amount of sharpening to apply to the image. Options include: NONE, LOW, MEDIUM, HIGH

NONELOWMEDIUMHIGHnull

denoise_levelnullable enum

The amount of denoising to apply to the image. Options include: NONE, LOW, MEDIUM, HIGH

NONELOWMEDIUMHIGHnull

clarity_levelnullable enum

The amount of clarity to apply to the image. Options include: NONE, LOW, MEDIUM, HIGH

NONELOWMEDIUMHIGHnull

privacyboolean

Whether to blur any faces or license plates in the image.

window_pullboolean

Whether to pull the windows in the image (used with AI version >= 4.0).

cloud_typenullable enum

The type of clouds in the new sky to replace the original sky with. Options include: CLEAR, LOW_CLOUD, HIGH_CLOUD

CLEARLOW_CLOUDHIGH_CLOUDnull

sky_saturation_levelnullable enum

NONELOWMEDIUMHIGHnull

contrast_boost_internalnullable enum

The amount of internal contrast boost to apply to the image. Options include: NONE, LOW, MEDIUM, HIGH

NONELOWMEDIUMHIGHnull

contrast_boost_externalnullable enum

The amount of external contrast boost to apply to the image. Options include: NONE, LOW, MEDIUM, HIGH

NONELOWMEDIUMHIGHnull

brightness_boost_internalnullable enum

The amount of external brightness boost to apply to the image. Options include: NONE, LOW, MEDIUM, HIGH

NONELOWMEDIUMHIGHnull

brightness_boost_externalnullable enum

The amount of external brightness boost to apply to the image. Options include: NONE, LOW, MEDIUM, HIGH

NONELOWMEDIUMHIGHnull

image_idstring (uuid)

user_idstring

The user ID of the user who uploaded (owns) the image.

order_idstring

image_namestring

image_typestring

The image type for the image.

date_addedinteger

The date the image was registered with Autoenhance.

scenestring

The detected scene of the image i.e garden, patio, kitchen, etc.

statusenum

The status of the order.

waitingprocessingprocessederror

enhancedboolean

Whether the image has been enhanced.

errorboolean

Whether the image has an error.

downloadedboolean

Whether image has been already downloaded and paid for.

ratinginteger

A rating between 0 and 5 on how good the image enhancmeent. Higher is better.

is_threesixtyany

Whether the image is a 360° image

Request

JavaScriptCurl

const response = await fetch('https://api.autoenhance.ai/v3/images/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "ai_version": 1.1,
  "enhance_type": "property",
  "sky_replacement": false,
  "vertical_correction": false,
  "lens_correction": false,
  "contrast_boost": "NONE",
  "brightness_boost": "NONE",
  "saturation_level": "NONE",
  "sharpen_level": "NONE",
  "denoise_level": "NONE",
  "clarity_level": "NONE",
  "privacy": false,
  "window_pull": false,
  "cloud_type": "CLEAR",
  "sky_saturation_level": "NONE",
  "contrast_boost_internal": "NONE",
  "contrast_boost_external": "NONE",
  "brightness_boost_internal": "NONE",
  "brightness_boost_external": "NONE",
  "image_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_id": "text",
  "order_id": "text",
  "image_name": "text",
  "image_type": "text",
  "scene": "text",
  "status": "waiting",
  "enhanced": false,
  "error": false,
  "downloaded": false
}

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;

Retrieve Order

Retrieve a specific order.

GEThttps://api.autoenhance.ai/v3/orders/{id}

Path parameters

id*string

Response

200404

Successful response

Body

application/json

order_idstring

The ID for the order.

namestring

The name for the order.

created_atstring (date-time)

The creation date of the order.

last_updated_atstring (date-time)

The last updated date of the order.

imagesarray of ImageOut (object)

statusenum

The status of the order.

waitingprocessingprocessederror

is_processingany

The processing status for the order

is_mergingany

The processing status for the order

Request

JavaScriptCurl

const response = await fetch('https://api.autoenhance.ai/v3/orders/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "order_id": "text",
  "name": "text",
  "created_at": "2024-04-20T03:44:06.708Z",
  "last_updated_at": "2024-04-20T03:44:06.708Z",
  "images": [
    {
      "ai_version": 1.1,
      "enhance_type": "property",
      "sky_replacement": false,
      "vertical_correction": false,
      "lens_correction": false,
      "contrast_boost": "NONE",
      "brightness_boost": "NONE",
      "saturation_level": "NONE",
      "sharpen_level": "NONE",
      "denoise_level": "NONE",
      "clarity_level": "NONE",
      "privacy": false,
      "window_pull": false,
      "cloud_type": "CLEAR",
      "sky_saturation_level": "NONE",
      "contrast_boost_internal": "NONE",
      "contrast_boost_external": "NONE",
      "brightness_boost_internal": "NONE",
      "brightness_boost_external": "NONE",
      "image_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_id": "text",
      "order_id": "text",
      "image_name": "text",
      "image_type": "text",
      "scene": "text",
      "status": "waiting",
      "enhanced": false,
      "error": false,
      "downloaded": false
    }
  ],
  "status": "waiting"
}

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.