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.

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();
}

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.

Authorizations
Path parameters
idstringRequired
Body
namestringOptional

The name for the order.

order_idstringOptional

The ID for the order.

Responses
200
Successful response
application/json
patch
PATCH /v3/orders/{id} HTTP/1.1
Host: api.autoenhance.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "order_id": "text"
}
{
  "created_at": "2025-06-05T06:02:06.429Z",
  "images": [
    {
      "ai_version": "text",
      "cloud_type": "CLEAR",
      "date_added": 1,
      "downloaded": true,
      "enhance": true,
      "enhance_type": "property",
      "image_id": "123e4567-e89b-12d3-a456-426614174000",
      "image_name": "text",
      "lens_correction": true,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "order_id": null,
      "privacy": true,
      "rating": 1,
      "scene": "text",
      "sky_replacement": true,
      "status": null,
      "status_reason": null,
      "upscale": true,
      "user_id": null,
      "vertical_correction": true,
      "window_pull": true,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "is_deleted": true,
  "is_merging": true,
  "is_processing": true,
  "last_updated_at": "2025-06-05T06:02:06.429Z",
  "name": "text",
  "order_id": "text",
  "status": null,
  "total_images": 1
}

Last updated