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

patch

Updates the details for the specific order. Images can be sorted using the sort_images_by parameter.

Authorizations

x-api-keystringRequired

Path parameters

idstringRequired

Query parameters

sort_images_byundefined · enumOptional

Specifies sort order for images in the order

Possible values:

Body

default_image_sort_orderundefined · enumOptional

Default sort order for images in the order. Prefix with '-' for descending order.

Possible values:

namestringOptional

The name for the order.

order_idstring · min: 1Optional

The ID for the order.

Responses

200

Successful response

application/json

created_atstring · date-timeOptional

The creation date of the order.

default_image_sort_orderundefined · enumOptional

Default sort order for images in the order.

Possible values:

is_deletedbooleanOptional

The status of the order.

is_mergingbooleanOptional

The processing status for the order

is_processingbooleanOptional

The processing status for the order

last_updated_atstring · date-timeOptional

The last updated date of the order.

namestringOptional

The name for the order.

order_idstringOptional

The ID for the order.

statusanyRead-onlyOptional

The status of the order.

total_imagesnumberOptional

Number of images in the order.

401

Authentication error

application/json

404

Not found

application/json

422

Validation error

application/json

patch/v3/orders/{id}

PATCH /v3/orders/{id} HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "default_image_sort_order": "name",
  "name": "text",
  "order_id": "text"
}

{
  "created_at": "2026-01-01T00:00:00.000Z",
  "default_image_sort_order": "name",
  "images": [
    {
      "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,
      "upscale": true,
      "user_id": null,
      "vertical_correction": true,
      "window_pull_type": "NONE",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "is_deleted": true,
  "is_merging": true,
  "is_processing": true,
  "last_updated_at": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "order_id": "text",
  "status": null,
  "total_images": 1
}