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.
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();
}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$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 -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
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
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.autoenhance.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"name": "text",
"order_id": "text"
}{
"created_at": "2025-10-30T01:26:03.111Z",
"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,
"preset_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_type": "NONE",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"is_deleted": true,
"is_merging": true,
"is_processing": true,
"last_updated_at": "2025-10-30T01:26:03.111Z",
"name": "text",
"order_id": "text",
"status": null,
"total_images": 1
}Last updated