Creating & Uploading
This API endpoint allows you to create an image. To create an image, you must provide a valid API key.
Creating image
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.
The type of clouds in the new sky to replace the original sky with. Options include: CLEAR, LOW_CLOUD, HIGH_CLOUD
Whether to enhance the image.
trueThe 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..
Correct any lens distortion in the image.
trueThe ID of the preset to apply to the image.
Whether to blur any faces or license plates in the image.
A rating between 0 and 5 on how good the image enhancmeent. Higher is better.
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.
Enable the replacement of the original sky for a summer sky.
Whether the image is a 360 image.
Whether to crop the bottom of 360-degree images to hide the tripod. Note: This performs a simple crop and does not use generative in-painting.
Whether to upscale the image.
Correct any vertical distortion in the image so that it appears straight.
trueWhat 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).
Successful response
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.
The type of clouds in the new sky to replace the original sky with. Options include: CLEAR, LOW_CLOUD, HIGH_CLOUD
The date the image was registered with Autoenhance.
Whether image has been already downloaded and paid for.
Whether to enhance the image.
trueThe 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..
Correct any lens distortion in the image.
trueThe ID of the parent image if this is a sub-image created for premium restaging. Null for original images.
The ID of the preset that was applied to the image.
Preset version applied when the image was last processed with a preset.
Whether to blur any faces or license plates in the image.
A rating between 0 and 5 on how good the image enhancmeent. Higher is better.
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.
The detected scene of the image i.e garden, patio, kitchen, etc.
Whether the sky replacement feature was enabled for the image.
The status of the order.
Reason for the image's current status
Whether to crop the bottom of 360-degree images to hide the tripod. Note: This performs a simple crop and does not use generative in-painting.
The upload URL for the image to be uploaded to.
Whether to upscale the image.
The user ID of the user who uploaded (owns) the image.
Whether the vertical correction feature was enabled for the image.
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).
Authentication error
Validation error
POST /v3/images/ HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 545
{
"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",
"grass": "AS_SHOT",
"photographer": "AS_SHOT",
"sky": "AS_SHOT",
"tvs": "AS_SHOT"
},
"sky_replacement": true,
"threesixty": true,
"tripod_hide": 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,
"parent_image_id": "text",
"preset_id": null,
"preset_version": null,
"privacy": true,
"rating": 1,
"restage": {
"fire_in_fireplaces": "AS_SHOT",
"grass": "AS_SHOT",
"photographer": "AS_SHOT",
"sky": "AS_SHOT",
"tvs": "AS_SHOT"
},
"scene": "text",
"sky_replacement": true,
"status": null,
"status_reason": null,
"tripod_hide": true,
"upload_url": null,
"upscale": true,
"user_id": null,
"vertical_correction": true,
"window_pull_type": "NONE",
"ANY_ADDITIONAL_PROPERTY": "anything"
}After successfully creating an image, the response will include an upload_url or s3PutObjectUrl if you're using an older API version. 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 || 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
Content-Type
eg. image/jpeg This value has to match the used content_type in create image request!
If you don't specify content_type in the create image request please specify application/octet-stream for the header value
Body
File or Blob
Image in a Blob or File format.
Response
Last updated
Was this helpful?