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

post

/v3/images/

Authorizations

Body

content_typestring

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

enhanceboolean · default: true

Whether to enhance the image.

hdrboolean

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

image_namestringrequired

lens_correctionboolean · default: true

Correct any lens distortion in the image.

order_idstring

privacyboolean | nullable

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

ratinginteger · max: 5

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

sky_replacementboolean

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

threesixtyboolean

Whether the image is a 360 image.

vertical_correctionboolean · default: true

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

window_pullboolean | nullable

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

ai_versionstring · enum

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

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

Options: CLEAR, LOW_CLOUD, HIGH_CLOUD, null

enhance_typeundefined · 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 or NEUTRAL..

Options: property, property_usa, warm, neutral

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.autoenhance.ai/v3/images/' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"enhance":true,"image_name":"text","lens_correction":true,"vertical_correction":true,"cloud_type":"CLEAR","enhance_type":"property"}'

200

401

422

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,
  "s3PutObjectUrl": null,
  "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

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"
}