Editing

This API endpoint allows you to edit any order you own. To reprocess an image, you must provide the order_id and a valid API key.

Important note Currently, you can only edit the name of your orders.

JavaScript

const apiKey = "YOUR_API_KEY";
const orderId = "ID_OF_YOUR_ORDER";

const editOrder = async (orderId, apiKey) => {
    const editOrderResponse = await fetch(
      `https://api.autoenhance.ai/v3/orders/${orderId}`,
      {
        method: "PATCH",
        headers: {
          "Content-Type": "application/json",
          "x-api-key": apiKey,
        },
        body: JSON.stringify({
          name:"Edited name of my order"
        }),
      }
    );

    const { order_id, name, images, status } = await editOrderResponse.json();
}

Python

import requests

api_key = "YOUR_API_KEY"
order_id = "ID_OF_YOUR_ORDER"

def edit_order(api_key, order_id):
    url = f"https://api.autoenhance.ai/v3/orders/{order_id}"
    headers = {
        "Content-Type": "application/json",
        "x-api-key": api_key,
    }
    payload = {
        "name": "Edited name of my order"
    }
    
    response = requests.patch(url, headers=headers, json=payload)
    response_data = response.json()
    
    order_id = response_data.get('order_id')
    name = response_data.get('name')
    images = response_data.get('images')
    status = response_data.get('status')

    return order_id, name, images, status

PHP

$order_id = "ID_OF_YOUR_ORDER";
$api_key = "YOUR_API_KEY";

function edit_order($order_id, $api_key) {
    $url = "https://api.autoenhance.ai/v3/orders/$order_id";
    $data = array(
        'name' => 'Edited name of my order'
    );

    $options = array(
        'http' => array(
            'header'  => "Content-Type: application/json\r\n" .
                         "x-api-key: $api_key",
            'method'  => 'PATCH',
            'content' => json_encode($data)
        )
    );

    $context = stream_context_create($options);
    $result = file_get_contents($url, false, $context);

    if ($result === FALSE) {
        return 'Error editing order';
    }

    $order_details = json_decode($result, true);
    return $order_details;
}

cURL

curl -X PATCH \
  'https://api.autoenhance.ai/v3/orders/YOUR_ORDER_ID' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
        "name": "Edited name of my order"
    }'

The response after successfully editing an order will contain all the details of your order with the uploaded values.

Specification

Update Order

Updates the details for the specific order.

PATCHhttps://api.autoenhance.ai//v3/orders/{id}

Path parameters

id*string

Body

application/json

namestring

The name for the order.

order_idstring

The ID for the order.

Response

200401404422

Successful response

Body

application/json

created_atstring (date-time)

The creation date of the order.

imagesarray of ImageOut (object)

is_mergingboolean

The processing status for the order

is_processingany

The processing status for the order

last_updated_atstring (date-time)

The last updated date of the order.

namestring

The name for the order.

order_idstring

The ID for the order.

statusenum

The status of the order.

waitingprocessingprocessederror

Request

JavaScriptCurlPython

const response = await fetch('https://api.autoenhance.ai//v3/orders/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401404422

{
  "created_at": "2024-09-08T00:49:58.642Z",
  "images": [
    {
      "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
    }
  ],
  "is_merging": false,
  "last_updated_at": "2024-09-08T00:49:58.642Z",
  "name": "text",
  "order_id": "text",
  "status": "waiting"
}