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 Image

HDR Brackets

Creating image

Create Image

post

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

ai_versionstringOptional

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_typestring · enum · nullableOptional

The type of clouds in the new sky to replace the original sky with. Options include: CLEAR, LOW_CLOUD, HIGH_CLOUD

Possible values:

enhancebooleanOptional

Whether to enhance the image.

Default: true

enhance_typestring · enumOptional

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

Possible values:

finetune_settingsany ofOptional

object · nullableOptional

or

objectOptional

image_namestringRequired

lens_correctionbooleanOptional

Correct any lens distortion in the image.

Default: true

order_idstring · min: 1Optional

preset_idstring · nullableOptional

The ID of the preset to apply to the image.

privacyboolean · nullableOptional

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

ratinginteger · max: 5Optional

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

restageany ofOptional

Restage options for in-painting or modifying scene elements. Allows correcting details like lighting a fireplace, removing fingerprints from a TV screen, or removing unwanted items like tripods.

or

object · nullableOptional

sky_replacementbooleanOptional

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

threesixtybooleanOptional

Whether the image is a 360 image.

upscalebooleanOptional

Whether to upscale the image.

vertical_correctionbooleanOptional

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

Default: true

window_pull_typestring · enum · nullableOptional

What type of window pull to apply to the image (Available since AI version >= 4.0, WITH_SKIES can only be used from AI version 5.2 or higher).

Possible values:

Other propertiesanyOptional

Responses

200

Successful response

application/json

ai_versionstringOptional

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_typestring · enum · nullableOptional

The type of clouds in the new sky to replace the original sky with. Options include: CLEAR, LOW_CLOUD, HIGH_CLOUD

Possible values:

date_addedintegerOptional

The date the image was registered with Autoenhance.

downloadedbooleanOptional

Whether image has been already downloaded and paid for.

enhancebooleanOptional

Whether to enhance the image.

Default: true

enhance_typestring · enumOptional

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

Possible values:

finetune_settingsany ofOptional

object · nullableOptional

or

objectOptional

image_idstring · uuidOptional

image_namestringOptional

lens_correctionbooleanOptional

Correct any lens distortion in the image.

Default: true

order_idanyRead-onlyOptional

preset_idanyRead-onlyOptional

The ID of the preset that was applied to the image.

privacyboolean · nullableOptional

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

ratinginteger · max: 5Optional

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

restageany ofOptional

Restage options for in-painting or modifying scene elements. Allows correcting details like lighting a fireplace, removing fingerprints from a TV screen, or removing unwanted items like tripods.

or

object · nullableOptional

scenestringOptional

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

sky_replacementbooleanOptional

Whether the sky replacement feature was enabled for the image.

statusanyRead-onlyOptional

The status of the order.

status_reasonanyRead-onlyOptional

Reason for the image's current status

upload_urlanyRead-onlyOptional

The upload URL for the image to be uploaded to.

upscalebooleanOptional

Whether to upscale the image.

user_idanyRead-onlyOptional

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

vertical_correctionbooleanOptional

Whether the vertical correction feature was enabled for the image.

window_pull_typestring · enum · nullableOptional

What type of window pull to apply to the image (Available since AI version >= 4.0, WITH_SKIES can only be used from AI version 5.2 or higher).

Possible values:

Other propertiesanyOptional

401

Authentication error

application/json

422

Validation error

application/json

post

/v3/images/

HTTPcURLJavaScriptPython

POST /v3/images/ HTTP/1.1
Host: api.autoenhance.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 492

{
  "ai_version": "text",
  "cloud_type": "CLEAR",
  "enhance": true,
  "enhance_type": "property",
  "finetune_settings": {},
  "image_name": "text",
  "lens_correction": true,
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "order_id": "text",
  "preset_id": "text",
  "privacy": true,
  "rating": 1,
  "restage": {
    "fire_in_fireplaces": "AS_SHOT",
    "photographer": "AS_SHOT",
    "tvs": "AS_SHOT"
  },
  "sky_replacement": true,
  "threesixty": true,
  "upscale": true,
  "vertical_correction": true,
  "window_pull_type": "NONE",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "ai_version": "text",
  "cloud_type": "CLEAR",
  "date_added": 1,
  "downloaded": true,
  "enhance": true,
  "enhance_type": "property",
  "finetune_settings": {},
  "image_id": "123e4567-e89b-12d3-a456-426614174000",
  "image_name": "text",
  "lens_correction": true,
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "order_id": null,
  "preset_id": null,
  "privacy": true,
  "rating": 1,
  "restage": {
    "fire_in_fireplaces": "AS_SHOT",
    "photographer": "AS_SHOT",
    "tvs": "AS_SHOT"
  },
  "scene": "text",
  "sky_replacement": true,
  "status": null,
  "status_reason": null,
  "upload_url": null,
  "upscale": true,
  "user_id": null,
  "vertical_correction": true,
  "window_pull_type": "NONE",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

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 upload_url

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