Uploading your first image

Time to enhance your first image with Autoenhance.ai API

Upload an image to our API in two stages. First, you must request a signed S3 URL, then upload the image to the signed s3. (This is AWS recommend way of uploading to a serverless API stack: https://aws.amazon.com/blogs/compute/uploading-to-amazon-s3-directly-from-a-web-or-mobile-application).

Create Image

POSThttps://api.autoenhance.ai/v3/images/

Authorization

ApiKeyAuth

Body

application/json

ratinginteger

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

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

Enable the replacement of the original sky for a summer sky.

vertical_correctionboolean

Correct any vertical distortion in the image so that it appears straight.

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_name*string

order_idstring

content_typestring

The MIME type of the image i.e. image/jpeg, image/png, etc.

threesixtyboolean

Whether the image is a 360 image.

hdrboolean

Whether the image is a HDR bracket. An order_id must be provided when this is set to true.

Response

200401422

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

s3PutObjectUrlany

The signed AWS S3 URL for the image to be uploaded to.

Request

JavaScriptCurl

const response = await fetch('https://api.autoenhance.ai/v3/images/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "image_name": "text"
    }),
});
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 you are trying to upload a 360 you will need to set "threesixty" to true.

Note that your image file has not been uploaded to our service yet. We’ll provide you with a signed S3 endpoint for uploading your image, called "s3PutObjectURL".

To upload your image to our service, make a PUT request to s3PutObjectURL with the image as a buffer. You will receive a 200 success code and an empty body confirming that you’ve uploaded the image successfully.

Upload image file to pre-signed S3 URL.

PUT {{ s3PutObjectURL }

The body should contain the data for your image and the Content-Type should be equal to what. you sent when creating the image

Headers

Name	Type	Description
Content-Type*	String

200

Once the image has been uploaded, our service will start enhancing your image.