Enhanced

Enhanced images are the final processed output from the AI. By default this endpoint will return a preview image you can show to your customers before they purchase the image. When they decide they want to download the image simply send ?preview=false to purchase and download the full sized image from Autoenhance. During development you can test this workflow without using your credits by utilizing development mode, simply set the x-dev-mode to true. You can learn more about the development mode here. In order to download enhanced images, you need to have a paid subscription or a credit, API key, and the image_id.

Don't have any credits? Subscribe for a monthly plan, or top up in our web application.

Before you continue Enhanced images come in various resolutions. You can add a query parameter size into the request url in order to choose between small, large or big resolution. Don't want to specify the size? Simply don't include it in the URL, and we will default the download to the biggest resolution.

const apiKey = "YOUR_API_KEY";
const imageId = "ID_OF_YOUR_IMAGE";

const downloadEnhancedImage = async (imageId, apiKey) => {
    const response = await fetch(
        `https://api.autoenhance.ai/v3/images/${imageId}/enhanced`,
        { 
            method: "GET",
            headers: {
                "x-api-key": apiKey,
            },
        }
    );
    const imageSource = await response.json()
    
    return imageSource
}

import requests

api_key = "YOUR_API_KEY"
image_id = "ID_OF_YOUR_IMAGE"

def download_enhanced_image(image_id, api_key):
    url = f'https://api.autoenhance.ai/v3/images/{image_id}/enhanced'
    headers = {
        'x-api-key': api_key
    }
    response = requests.get(url, headers=headers)
    image_source = response.json()
    
    return image_source

$image_id = "ID_OF_YOUR_IMAGE";
$api_key = "YOUR_API_KEY";

function download_enhanced_image($image_id, $api_key) {
    $url = "https://api.autoenhance.ai/v3/images/$image_id/enhanced";

    $options = array(
        'http' => array(
            'header'  => "Content-Type: application/json\r\n" .
                         "x-api-key: $api_key",
            'method'  => 'GET'
        )
    );

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

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

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

Development mode

If you want to test downloading enhanced images without using your credits, you can include a request header x-dev-mode .

const apiKey = "YOUR_API_KEY";
const imageId = "ID_OF_YOUR_IMAGE";

const downloadEnhancedImage = async (imageId, apiKey) => {
    const response = await fetch(
        `https://api.autoenhance.ai/v3/images/${imageId}/enhanced`,
        { 
            method: "GET",
            headers: {
                "x-api-key": apiKey,
                "x-dev-mode": true,
            },
        }
    );
    const imageSource = await response.json()
    
    return imageSource
}

import requests

api_key = "YOUR_API_KEY"
image_id = "ID_OF_YOUR_IMAGE"

def download_enhanced_image(image_id, api_key):
    url = f'https://api.autoenhance.ai/v3/images/{image_id}/enhanced'
    headers = {
        'x-api-key': api_key
        'x-dev-mode': True
    }
    response = requests.get(url, headers=headers)
    image_source = response.json()
    
    return image_source

$image_id = "ID_OF_YOUR_IMAGE";
$api_key = "YOUR_API_KEY";

function download_enhanced_image($image_id, $api_key) {
    $url = "https://api.autoenhance.ai/v3/images/$image_id/enhanced";

    $options = array(
        'http' => array(
            'header'  => "Content-Type: application/json\r\n" .
                         "x-api-key: $api_key\r\n" .
                         "x-dev-mode: true\r\n", 
            'method'  => 'GET'
        )
    );

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

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

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

When this header is present, the API will return images with a development watermark.

Once you are satisfied with the results, simply remove the header to start downloading fully enhanced images without the watermark (credits will be consumed).

Specification

Download Enhanced Image

get

Authorizations

x-api-keystringRequired

Path parameters

idstringRequired

Query parameters

dpiinteger · min: 72Optional

DPI of the image, must at least be 72.

qualityinteger · min: 1 · max: 90Optional

Quality of the image, must be between 1 and 90.

formatstring · enumOptional

Format of the image, must be one of 'avif', 'png', 'jpeg', 'jxl', or 'webp'.

Possible values:

previewbooleanOptional

Whether to show a lower quality preview version.

watermarkbooleanOptional

Whether to apply a watermark to the image.

finetunedboolean · nullableOptional

Whether to apply finetuning to the image.

Default: null

finetuneboolean · nullableOptional

Whether to apply finetuning to the image. Deprecated: use 'finetuned' instead.

Default: null

restagedbooleanOptional

Whether to serve the restaged version of the image. Defaults to True (serve restaged if available). Set to False to serve the original enhanced image without restaging.

Default: true

max_widthinteger · min: 1Optional

Maximum width of the image in pixels. Must be a positive integer.

scalenumber · max: 1Optional

Scale factor for the image, must be between 0.0 and 1.0.

Responses

200

Successful response

image/jpeg

string · binaryOptional

401

Authentication error

application/json

404

Not found

application/json

422

Validation error

application/json

get

/v3/images/{id}/enhanced

GET /v3/images/{id}/enhanced HTTP/1.1
Host: api.autoenhance.ai
x-api-key: YOUR_API_KEY
Accept: */*

binary

PreviousOriginal NextOrders

Last updated 2 months ago

Was this helpful?

hashtagDevelopment mode

hashtagSpecification

hashtagDownload Enhanced Image

Development mode

Specification

Download Enhanced Image