Creating & Uploading

This API endpoint allows you to create an image. To create an image, you must provide a valid API key.

We've prepared quick start guides for uploading images the simplest way possible. If you're stuck, or perhaps want to see simple code examples, then start over there!

Single Brackets

HDR

360

Creating image

Create Image

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

Authorization

ApiKeyAuth

Body

application/json

ai_versionstring

The version of the AI model to use for enhancing the image.

brightness_boostnullable enum

The amount of 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

brightness_boost_internalnullable enum

The amount of external brightness boost 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

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

content_typestring

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

contrast_boostnullable enum

The amount of 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

contrast_boost_internalnullable enum

The amount of internal contrast boost 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

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

propertyproperty_usawarmneutralauthentic

hdrboolean

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

image_name*string

lens_correctionboolean

Correct any lens distortion in 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.

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

sky_replacementboolean

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

threesixtyboolean

Whether the image is a 360 image.

vertical_correctionboolean

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

window_pullnullable boolean

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

Response

200401422

Successful response

Body

application/json

ai_versionstring

The version of the AI model to use for enhancing the image.

brightness_boostnullable enum

The amount of 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

brightness_boost_internalnullable enum

The amount of external brightness boost 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

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

contrast_boostnullable enum

The amount of 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

contrast_boost_internalnullable enum

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

NONELOWMEDIUMHIGHnull

date_addedinteger

The date the image was registered with Autoenhance.

denoise_levelnullable enum

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

NONELOWMEDIUMHIGHnull

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

propertyproperty_usawarmneutralauthentic

enhancedboolean

Whether the image has been enhanced.

errorboolean

Whether the image has an error.

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.

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.

s3PutObjectUrlany

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

saturation_levelnullable enum

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

NONELOWMEDIUMHIGHnull

scenestring

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

sharpen_levelnullable enum

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

NONELOWMEDIUMHIGHnull

sky_replacementboolean

Whether the sky replacement feature was enabled for the image.

statusenum

The status of the order.

waitingprocessingprocessederror

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

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": "text",
  "brightness_boost": "NONE",
  "brightness_boost_external": "NONE",
  "brightness_boost_internal": "NONE",
  "clarity_level": "NONE",
  "cloud_type": "CLEAR",
  "contrast_boost": "NONE",
  "contrast_boost_external": "NONE",
  "contrast_boost_internal": "NONE",
  "denoise_level": "NONE",
  "downloaded": false,
  "enhance": true,
  "enhance_type": "property",
  "enhanced": false,
  "error": false,
  "image_id": "123e4567-e89b-12d3-a456-426614174000",
  "image_name": "text",
  "image_type": "text",
  "lens_correction": true,
  "order_id": "text",
  "privacy": false,
  "saturation_level": "NONE",
  "scene": "text",
  "sharpen_level": "NONE",
  "sky_replacement": false,
  "status": "waiting",
  "user_id": "text",
  "vertical_correction": false,
  "window_pull": false
}

All of your uploaded images will contain an order_id even if you don't specify it. If you want to upload multiple images into an order, you need to specify the order_id while creating the image in our API. Learn more on the Orders page.

After successfully creating an image, the response will include an s3PutObjectUrl. To upload the physical image to our service, make a PUT request to this URL with the image in the body of the request.

Uploading image

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	Value
Content-Type	eg. image/jpeg This value has to match the used contentType in create image request!

Body

Type	Description
File or Blob	Image in a Blob or File format.

Response

200

{
  "status": "success"
}

400

{
  "error": "Invalid request"
}