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).
Request Signed S3 URL
POST
https://api.autoenhance.ai/v2/image
Using the POST /image endpoint we are requesting a presigned S3 URL to upload the file to Autoenhance.ai for enhancement.
Headers
Name | Type | Description |
---|---|---|
x-api-key* | String | Provide your API key, found in the developer portal. |
Request Body
Name | Type | Description |
---|---|---|
enhance_type | String | Type of image you want enhanced (e.g. property or food). |
order_id | String | UUID string to link a group of images under one order (e.g. b1aa3999-7908-45c9-9a99-82e25cf5de8e). |
content_type* | String | Mime file type (e.g. image/jpeg). |
image_name* | String | Name of the image file (e.g. house.jpg). |
sky_replacement | Bool | Enable/Disable sky replacement. By default, this is true. |
vertical_correction | Bool | Enable/Disable vertical correction. By default, this is true. |
sky_type | String | Set specific sky type. (Options: UK_SUMMER, UK_WINTER or USA_SUMMER). Default is UK_SUMMER. |
cloud_type | String | Set specific cloud type. (Options: CLEAR, LOW_CLOUD or HIGH_CLOUD). Default is HIGH_CLOUD. |
contrast_boost | String | Set contrast boost level. (Options: NONE, LOW, MEDIUM or HIGH). Default is LOW. |
hdr | Bool | Enable/Disable HDR. By default, this is false. HDR will require multiple brackets, and an additional API call. Read more on how to enhance HDR. |
threesixty | Bool | Enable/Disable 360 enhancement. By default, this is false. 360 enhancement requires a 360 panorama. |
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
https://autoenhanceapi-prod.s3.eu-west-1.amazonaws.com/0e53fb15-5ca2-4757-b631-14294cafd0ea/original.jpeg
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String | Content type of image (e.g. image/jpg) |
Once the image has been uploaded, our service will start enhancing your image.
Last updated