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

get

/v3/images/{id}

Path parameters

idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.autoenhance.ai/v3/images/{id}'

200

404

200

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

Successful response