Retrieveing

This API endpoint allows you to retrieve a image. To retrieve an image, you must provide the image_id.

JavaScript

const imageId = "ID_OF_YOUR_IMAGE";

const getImage = async (imageId) => {
    const getImageResponse = await fetch(
      `https://api.autoenhance.ai/v3/images/${imageId}`,
      { method: "GET" }
    );

    const image = await getOrderResponse.json();
}

Python

image_id = "ID_OF_YOUR_IMAGE";

def get_image(image_id):
    url = f"https://api.autoenhance.ai/v3/images/{image_id}"
    
    response = requests.get(url)
    response_data = response.json()
    
    return response_data

PHP

$image_id = "ID_OF_YOUR_IMAGE";

function get_image($image_id) {
    $url = "https://api.autoenhance.ai/v3/images/$image_id";

    $options = array(
        'http' => array(
            'method'  => 'GET',
        ),
    );

    $context  = stream_context_create($options);
    $result = file_get_contents($url, false, $context);

    if ($result === FALSE) {
        return 'Error getting image';
    }

    $image = json_decode($result, true);
   
    return $image;
}

cURL

curl -X GET \
  https://api.autoenhance.ai/v3/images/ID_OF_YOUR_IMAGE \
  -H 'Content-Type: application/json'

The response after successfully fetching an image will contain all the details of your image.

Specification

Retrieve Image

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

Path parameters

id*string

Response

200404

Successful response

Body

application/json

ai_versionenum

The version of the AI model to use for enhancing the image. Versions ending in an .x will use the latest minor version as soon as it's published.

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

date_addedinteger

The date the image was registered with Autoenhance.

downloadedboolean

Whether image has been already downloaded and paid for.

enhanceboolean

Whether to enhance the image.

enhance_typeenum

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 or NEUTRAL..

propertyproperty_usawarmneutral

image_idstring (uuid)

image_namestring

image_typestring

The image type for the image.

is_threesixtyany

Whether the image is a 360° image

lens_correctionboolean

Correct any lens distortion in the image.

metadataobject

Metadata for the image.

order_idstring

privacynullable boolean

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

ratinginteger

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

scenestring

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

sky_replacementboolean

Whether the sky replacement feature was enabled for the image.

statusenum

The status of the order.

waitingprocessingprocessederrorexpired

status_reasonany

Reason for the image's current status

user_idstring

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

vertical_correctionboolean

Whether the vertical correction feature was enabled for the image.

window_pullnullable boolean

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

Request

JavaScriptCurlPython

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

Response

200404

{
  "ai_version": "text",
  "cloud_type": "CLEAR",
  "date_added": 0,
  "downloaded": false,
  "enhance": true,
  "enhance_type": "property",
  "image_id": "123e4567-e89b-12d3-a456-426614174000",
  "image_name": "text",
  "image_type": "text",
  "lens_correction": true,
  "order_id": "text",
  "privacy": false,
  "rating": 0,
  "scene": "text",
  "sky_replacement": false,
  "status": "waiting",
  "user_id": "text",
  "vertical_correction": false,
  "window_pull": false
}